使用DescribeRefreshTaskById查询刷新预热任务状态-CDN-阿里云

调用DescribeRefreshTaskById查询刷新状态和预热状态是否在全网生效。

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cdn:DescribeRefreshTaskById

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	待查询的任务 ID。您可以调用 RefreshObjectCaches 接口，从其返回值中获取刷新预热的任务 ID，并通过任务 ID 查询源站资源的刷新状态。支持同时传入多个任务 ID，多个任务 ID 之间用英文逗号（,）分隔，最多支持同时传入 10 个任务 ID。	12345678

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	任务总个数。	2
RequestId	string	请求 ID。	E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
Tasks	array<object>	任务列表。
	object
Status	string	任务状态。取值： Complete：已完成。 Refreshing：处理中。 Failed：失败。	Complete
CreationTime	string	任务对象创建时间，使用 UTC 时间表示。	2020-08-03T08:54:23Z
ObjectType	string	任务类型。取值： file：单文件刷新。 directory：目录刷新。 preload：单文件预热。 regex：正则刷新。	file
Process	string	任务完成进度百分比。	100%
Description	string	刷新预热失败后返回的错误描述。取值： Internal Error：内部错误。 Origin Timeout：源站响应超时。 Origin Return StatusCode 5XX：源站响应 5xx 错误码。	Internal Error
ObjectPath	string	刷新对象的路径。	http://example.com/abc.jpg
TaskId	string	任务 ID。	24840

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2020-08-03T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/abc.jpg",
      "TaskId": "24840"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	请同时提供开始时间和结束时间。
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.	起始时间格式错误。请核对后重新提供。
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	结束时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	用户参数中EndTime早于StartTime
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	起始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidEndTime.ValueNotSupported	The specified EndTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidParameters	The parameters you provided are invalid.
400	InvalidTime	The query time cannot exceed the last 3 days.
429	TooManyRequests	Too many requests, please try again later

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

变更历史

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