按云服务商获取刷新和预热任务列表--多云CDN-火山引擎

文档中心

立即注册

导航

按云服务商获取刷新和预热任务列表

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

调用本接口查询云服务商平台的刷新和预热任务列表。

每个请求必须指定一个云服务商账号和任务类型，以查询该账号下的文件刷新、目录刷新或文件预热任务。
多云CDN调用云服务商提供的刷新和预热任务列表查询接口，以获取相关数据。

使用说明

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

使用限制

节流限制：您每秒最多可以提交 30 个 API 请求。
云服务商平台接口限制：
以下云服务商产品不支持刷新和预热任务列表查询功能：
- 火山引擎—DCDN
- 华为云—CDN
- 金山云—CDN
- UCloud—UCDN
- Akamai—AMD 和 DSA
- AWS—CloudFront
- Google Cloud—Media CDN
- 中国移动—CDN
- Azure—CDN

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
TaskType	String	是	要查询的任务的类型。该参数有以下取值： `refresh_dir`：目录刷新 `refresh_file`：文件刷新 `preload`：文件预热	`refresh_dir`
CloudAccountId	String	是	要使用的云服务商账号的 ID。说明您可以调用 ListCloudAccounts 接口查询多云CDN中所有云服务商账号的 ID。	`62bdbc3d54f3fa9551ea****`
VendorTaskId	String	否	指定一个由云服务商平台返回的刷新或预热任务的 ID，查询该任务的信息。	`da928f3b-58e7-44f6-9d39-4deed32a150a`
StartTime	Long	否	设置一个开始时间，格式是 Unix 时间戳。该参数与 `EndTime` 一起指定了一个时间段。本接口返回在指定时间段内创建的任务。说明如果您未指定时间段或者指定了无效的时间段，则接口默认返回在过去 24 小时内创建的任务。	`1658883449`
EndTime	Long	否	设置一个结束时间，格式是 Unix 时间戳。该参数与 `StartTime` 一起指定了一个时间段。本接口返回在指定时间段内创建的任务。说明如果您未指定时间段或者指定了无效的时间段，则接口默认返回在过去 24 小时内创建的任务。	`1658915851`
ProductType	String	否	指定一个云产品类型，查询该类型产品的相关数据。该参数有以下取值： `cdn`：静态加速产品 `dcdn`：动态加速产品	`cdn`
Pagination	Object	否	对查询结果进行分页并返回特定页码上的任务。
SubProduct	String	否	指定一个云产品，查询该产品的相关数据。该参数有以下取值： `cdn`：内容分发网络（CDN） `ucdn`：UCloud UCDN `cloudfront`：AWS CloudFront `amd`：Akamai AMD `dsa`：Akamai DSA `media_cdn`：Google Cloud Media CDN `dcdn`：全站加速（DCDN） `ecdn`：腾讯云 ECDN `edgeone`：腾讯云 EdgeOne	`cdn`

响应正文

参数名称	数据类型	参数说明	示例
Tasks	Object[]	任务详情列表。
Pagination	Object	分页详情。

请求示例

POST https://open.volcengineapi.com/?Action=ListVendorContentTask&Version=2022-03-01&<其他公共请求参数>=
{
    "TaskType": "refresh_file",
    "CloudAccountId": "62bdbc3d54f3fa9551ea****",
    "Pagination": {
        "PageNum": 1,
        "PageSize": 20
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202207241852340102120972071193A640",
        "Action": "ListVendorContentTask",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tasks": [
            {
                "VendorTaskId": "da928f3b-58e7-44f6-9d39-4deed32a150a",
                "Url": "http://www.example.com/",
                "Status": "complete",
                "CreatedAt": 1658639867,
                "Description": ""
            },
            {
                "VendorTaskId": "da928f3b-5867-44f6-9259-4deed3er150a",
                "Url": "http://img.example.com/1.jpg",
                "Status": "complete",
                "CreatedAt": 1658624478,
                "Description": ""
            }
        ],
        "Pagination": {
            "PageSize": 20,
            "PageNum": 1,
            "Total": 2
        }
    }
}

错误码

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