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

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

最近更新时间2023.06.02 13:17:42

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

API 说明

API 名称:ListVendorContentTask
API 域名:open.volcengineapi.com
API 描述:获取某个云服务商下的目录刷新、文件刷新和文件预热任务列表。

请求方法

POST

使用限制

  • 节流限制:每秒最多提交 30 个请求。
  • 云服务商 CDN 接口的限制:
    多云CDN调用云服务商 CDN 的相关接口以获取刷新和预热任务列表。由于云服务商 CDN 接口能力的限制,多云CDN不支持获取以下 CDN 的刷新和预热任务列表:
    • 华为云 CDN
    • 金山云 CDN
    • UCloud CDN
    • AWS CloudFront
    • Akamai AMD/DSA

公共查询参数

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

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

请求正文

参数名称
数据类型
是否必选
参数说明
示例
TaskType
String
表示任务的类型。该参数有以下取值:
  • refresh_dir:表示目录刷新。
  • refresh_file:表示文件刷新。
  • preload:表示文件预热。
refresh_dir
CloudAccountId
String
表示一个云服务商账号的 ID。该账号是在多云CDN中创建的。您可以调用 ListCloudAccounts 查询所有云服务商账号的 ID。
da928f3b-58e7-44f6-9d39-4deed32a150a
VendorTaskId
String
表示在该云服务商账号下的一个刷新或预热任务的 ID。如果不指定该参数,则查询所有的任务。
da928f3b-58e7-44f6-9d39-4deed32a150a
StartTime
Integer
表示一个开始时间,格式是 Unix 时间戳。该 API 查询那些创建时间大于或等于该时间的刷新或预热任务。如果不指定 StartTime 或者 StartTime 和 EndTime 指定的时间段无效,则使用的时间段是过去的 24 小时。
1658883449
EndTime
Integer
表示一个结束时间,格式是 Unix 时间戳。该 API 查询那些创建时间小于或等于该时间的刷新或预热任务。如果不指定 EndTime 或者 StartTime 和 EndTime 指定的时间段无效,则使用的时间段是过去的 24 小时。
1658915851
ProductType
String
表示该云服务商账号所关联的云服务类型。当前该参数的值是 cdn。
cdn
Pagination
PagingOption
表示对查询结果进行分页并返回特定页码上的任务。如果不指定该参数,则使用该参数的默认值对结果进行分页并返回结果。

响应正文

参数名称
数据类型
参数说明
示例
Tasks
UrlInfo[]
表示一个任务对象的列表。每个任务对象包含相应任务的详细信息。
Pagination
PagingResult
表示一个分页详情的对象。

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-03-01&Action=ListVendorContentTask&<其他公共请求参数>
{
    "TaskType":"refresh_file",
    "CloudAccountId":"62bdbc3d54f3fa9551ea9569",
    "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 请求失败。关于更多错误码的信息,参见错误码