调用DescribeDcdnRefreshTaskById查询刷新或预热任务的状态和进度-边缘安全加速-阿里云

调用DescribeDcdnRefreshTaskById通过任务编号查询刷新或预热是否在全网生效。

接口说明

说明

支持查询 3 天内（包含 3 天）的数据。
单用户调用频率为 30 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dcdn:DescribeDcdnRefreshTaskById

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	待查询的任务 ID。具体如下：调用 RefreshDcdnObjectCaches 接口，获取刷新任务 ID。调用 PreloadDcdnObjectCaches 接口，获取预热任务 ID。说明每次调用最多可以传入 10 个任务 ID，多个任务 ID 用英文逗号（,）分隔。	113681**

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	任务总个数。	2
RequestId	string	请求 ID。	E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
Tasks	array<object>	刷新或预热任务列表。
	object
Status	string	任务状态。取值： Complete：已完成。 Pending：等待刷新。 Refreshing：刷新中。 Failed：刷新失败。	Complete
CreationTime	string	任务创建时间。使用 UTC 时间表示，格式为 yyyy-MM-ddTHH:mm:ssZ。	2021-05-10T08:54:23Z
ObjectType	string	刷新或预热任务类型。取值： file：单文件刷新。 directory：目录刷新。 preload：单文件预热。	file
Process	string	任务完成进度百分比。	100%
Description	string	刷新或预热失败后返回的错误描述。取值： Internal Error：内部错误。 Origin Timeout：源站响应超时。 Origin Return StatusCode 5XX：源站响应 5xx 错误码。	Internal Error
ObjectPath	string	刷新或预热对象的路径。	http://example.com/image_01.png
TaskId	string	查询到的任务 ID。	113681**

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2021-05-10T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/image_01.png",
      "TaskId": "113681**"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameters	The specified parameters are invalid.	参数非法。
400	InvalidTaskId.Malformed	The specified TaskId is invalid.	TaskId错误，请填写正确的TaskId。
400	InvalidTaskId	The maximum number of taskIds is 10.	taskIds个数不能超过10.
400	InvalidTime	The query time cannot exceed the last 3 days.	查询时间不能超过最近3天。
429	TooManyRequests	The server is busy. Please try again later.	服务器忙，请稍后再试

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。