You need to enable JavaScript to run this app.
导航

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

最近更新时间2023.09.06 11:03:27

首次发布时间2022.07.28 21:39:27

API 说明

API 名称:DescribeContentTaskByTaskId
API 域名:open.volcengineapi.com
API 描述:指定一个刷新或预热任务的 ID,获取该任务的详细信息与执行状态。

请求方法

POST

使用限制

  • 节流限制:每秒最多提交 30 个请求。
  • 云服务商 CDN 接口的限制:
    多云CDN调用云服务商 CDN 的相关接口以查询刷新和预热任务的执行状态。由于云服务商 CDN 接口能力的限制,多云CDN不支持查询以下 CDN 的刷新和预热任务的状态:
    • Akamai AMD/DSA

公共查询参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
Action
String
API 的名称。该参数的取值是 DescribeContentTaskByTaskId
Version
String
API 的版本。该参数的取值是 2022-03-01

请求正文

参数名称数据类型是否必选参数说明示例
TaskIdString表示在多云CDN提交的刷新或预热任务 ID。您可以调用 ListContentTask 查询所有刷新与任务任务的 ID。62dc99fd56139eaa6c426cbd

响应正文

参数名称
数据类型
参数说明
示例
SubTasks
SubUrlInfo[]
在多云CDN提交的刷新或预热任务会在相应的那些云服务商账号下创建实际的刷新或预热任务。该参数表示这些云服务商任务对象的列表。每个对象包含相应的云服务商任务的详细信息与执行状态。
VendorsMetaData
ContentVendorMetaData[]
表示一个云服务商帐号对象的列表。每个对象包含一个账号的信息。对于这些账号,该 API 无法获得提交的刷新或预热任务的信息。

示例

请求示例

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

响应示例

{
    "ResponseMetadata": {
        "RequestID": "20220724095754010212072096128F0316",
        "Action": "DescribeContentTaskByTaskId",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "SubTasks": [
            {
                "VendorTaskIds": [
                    "da928f3b-58e7-44f6-9d39-4deed32a150a"
                ],
                "Url": "https://http://www.example2.com",
                "Status": "complete",
                "CreatedAt": 1658624509,
                "Description": "",
                "TaskId": "62dc99fd56fd9eaa6c426abd",
                "CloudAccountId": "629b69d1a3997251b23a6385",
                "Vendor": "ksyun",
                "TaskType": "preload",
                "ProductType": ""
            },
            {
                "VendorTaskIds": [
                    "da928f3b-58e7-44f6-9d39-4deed32a150a"
                ],
                "Url": "http://www.example1.com",
                "Status": "failed",
                "CreatedAt": 1658624509,
                "Description": "",
                "TaskId": "62dc99fd56fd9eaa6c426abd",
                "CloudAccountId": "629b69d1a3997251b23a6385",
                "Vendor": "ksyun",
                "TaskType": "preload",
                "ProductType": ""
            }
        ],
        "VendorsMetaData": []
    }
}

错误代码

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