按任务ID查询任务执行状态--多云CDN-火山引擎

文档中心

立即注册

导航

按任务ID查询任务执行状态

最近更新时间：2024.08.23 17:21:11首次发布时间：2022.07.28 21:39:27

调用本接口查询通过多云CDN提交的刷新或预热任务的详细信息和执行状态。

您可以通过任务 ID 指定要查询的任务。每次请求仅允许指定一个任务 ID。
您通过多云CDN提交刷新或预热任务到云服务商平台后，多云CDN将分别调用云服务商平台的接口，在云服务商平台创建相应的子任务。本接口查询的是云服务商平台中相应子任务的执行状态。
多云CDN调用云服务商提供的刷新或预热任务执行状态查询接口，以获取相关数据。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。

使用限制

节流限制：您每秒最多可以提交 30 个 API 请求。
云服务商平台接口限制：
以下云服务商产品不支持刷新或预热任务执行结果的查询功能：
- 火山引擎—DCDN
- Akamai—AMD 和 DSA
- Google Cloud—Media CDN
- Azure—CDN

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=DescribeContentTaskByTaskId&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeContentTaskByTaskId`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
TaskId	String	是	要查询的刷新或预热任务的 ID。说明您可以调用 ListContentTasks 接口查询所有刷新与预热任务的 ID。	`62dc99fd56139eaa6c426cbd`

响应正文

参数名称	数据类型	参数说明	示例
SubTasks	Object[]	在云服务商平台创建的刷新或预热子任务的信息列表。
VendorsMetaData	Object[]	多云CDN未能从云服务商平台获得子任务信息的情形下，所返回的原始请求信息。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeContentTaskByTaskId&Version=2022-03-01&<其他公共请求参数>=
{
    "TaskId": "62dc99fd56fd9eaa6c426abd"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "2024021911500443E250F1BE036D2845D8",
        "Action": "DescribeContentTaskByTaskId",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "SubTasks": [
            {
                "VendorTaskIds": [
                    "501278034180013226"
                ],
                "Url": "https://www.example.com/1.txt",
                "Status": "executing",
                "CreatedAt": 1708314591,
                "Description": "",
                "TaskId": "62dc99fd56fd9eaa6c426abd",
                "CloudAccountId": "655372974da3635feec7****",
                "CloudAccountName": "volctest",
                "Vendor": "tencent",
                "TaskType": "preload",
                "ProductType": "cdn",
                "SubProduct": "cdn"
            }
        ],
        "VendorsMetaData": []
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。