全部产品
Search

搜索本产品

    CDN：DescribeRefreshTaskById - 查询刷新预热任务-按ID

    文档中心

    CDN：DescribeRefreshTaskById - 查询刷新预热任务-按ID

    更新时间：Dec 18, 2024

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

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    TaskIdstring是

    待查询的任务 ID。

    您可以调用 RefreshObjectCaches 接口，从其返回值中获取刷新预热的任务 ID，并通过任务 ID 查询源站资源的刷新状态。

    支持同时传入多个任务 ID，多个任务 ID 之间用英文逗号（,）分隔，最多支持同时传入 10 个任务 ID。

    		12345678

    返回参数

    名称类型描述示例值
    object
    TotalCountlong

    任务总个数。

    		2
    RequestIdstring

    请求 ID。

    		E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
    Tasksarray<object>

    任务列表。

    CDNTaskobject
    Statusstring

    任务状态。取值：

    • Complete：已完成。
    • Refreshing：刷新中。
    • Failed：刷新失败。
    		Complete
    CreationTimestring

    任务对象创建时间，使用 UTC 时间表示。

    		2020-08-03T08:54:23Z
    ObjectTypestring

    任务类型。取值：

    • file：单文件刷新。
    • directory：目录刷新。
    • preload：单文件预热。
    • regex：正则刷新。
    		file
    Processstring

    任务完成进度百分比。

    		100%
    Descriptionstring

    刷新预热失败后返回的错误描述。取值：

    • Internal Error：内部错误。
    • Origin Timeout：源站响应超时。
    • Origin Return StatusCode 5XX：源站响应 5xx 错误码。
    		Internal Error
    ObjectPathstring

    刷新对象的路径。

    		http://example.com/abc.jpg
    TaskIdstring

    任务 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错误码错误信息描述
    400InvalidTaskId.MalformedThe specified TaskId is invalid.-
    400InvalidObjectPath.MalformedThe specified ObjectPath is invalid.-
    400MissingTimeParameterThe StartTime and EndTime must be both specified.请同时提供开始时间和结束时间。
    400MissingParameter.ObjectTypeThe ObjectType parameter is required if DomainName or ObjectType is specified.-
    400InvalidStartTime.MalformedThe specified StartTime is invalid.起始时间格式错误。请核对后重新提供。
    400InvalidEndTime.MalformedThe specified EndTime is invalid.结束时间格式错误。日期格式请参考所调用API的帮助文档说明。
    400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.用户参数中EndTime早于StartTime
    400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.起始时间格式错误。日期格式请参考所调用API的帮助文档说明。
    400InvalidEndTime.ValueNotSupportedThe specified EndTime is invalid.-
    400InvalidObjectType.ValueNotSupportedThe specified ObjectType is not supported.-
    400InvalidStatus.ValueNotSupportedThe specified Status is not supported.-
    400DomainNameOverLimitA maximum of 500 domains are supported for each request.-
    400InvalidTaskId.MalformedThe count of taskIds should be between 1 and 10.-
    400InvalidParametersThe parameters you provided are invalid.-
    400InvalidTimeThe query time cannot exceed the last 3 days.-
    429TooManyRequestsToo many requests, please try again later-

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

    变更历史

    变更时间变更内容概要操作
    2024-12-18OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情