DescribePreloadTasks - 查询预热任务详情

更新时间: 2024-12-26 16:40:18

查询任务预热详情,支持按时间、任务状态、预热URL进行分页查询。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
SiteIdlong

站点 ID,可通过调用 ListSites 接口获取。

123456789****
Contentstring

查询内容,精确匹配。

http://a.com/1.jpg?b=2
PageNumberinteger

页码。取值范围为:1~100000。 默认值:1

1
PageSizeinteger

分页大小。默认值:20,最大值:50。取值为1~50之间的任意整数。

20
StartTimestring

开始时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-03-22T17:00:00Z
EndTimestring

结束时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需大于起始时间。
2023-03-23T06:23:00Z
Statusstring

任务执行状态。取值:

  • Complte:完成。
  • Refreshing:刷新中。
  • Failed:刷新失败。
Complete

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageNumberlong

页码。

1
PageSizelong

整页大小。

10
TotalCountlong

总条数。

83
Tasksarray<object>

任务列表。

Taskobject
Statusstring

任务状态。

  • Complete:完成。
  • Refreshing:预热中。
  • Failed:预热失败。
Complete
CreateTimestring

创建时间。

2023-03-28 14:28:57
Processstring

任务完成进度百分比。

100%
Descriptionstring

预热失败后返回的错误描述。取值:

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

预热对象。

http://a.com/1.jpg?b=2
TaskIdstring

查询到的任务 ID。

1597854579687428

示例

正常返回示例

JSON格式

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 83,
  "Tasks": [
    {
      "Status": "Complete",
      "CreateTime": "2023-03-28 14:28:57",
      "Process": "100%",
      "Description": "Internal Error",
      "Content": "http://a.com/1.jpg?b=2",
      "TaskId": "1597854579687428"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400MissingTimeParameterThe StartTime and EndTime must be both specified.请同时提供开始时间和结束时间。
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.您填入的结束时间早于开始时间,请检查后重试。
400DomainNameOverLimitA maximum of 500 domains are supported for each request.一次最多只支持500个域名,请减少域名重新请求。
400InvalidTimeThe query time cannot exceed the last 3 days.查询时间不能超过最近3天。
400MissingParameter.ObjectTypeThe ObjectType parameter is required if DomainName or ObjectType is specified.请填写ObjectType参数。
400InvalidStationParameterThe specified Station is invalid.指定的节点参数无效。
400TooManyRequestsToo many requests.Please try again later.请求过于频繁,请稍后重试。
400InvalidTaskId.MalformedThe specified taskId is invalid.指定的任务ID无效。
400InvalidParameters.InvalidUrlsThe specified urls are invalid.请求的URL参数无效。

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

上一篇: 预热缓存 下一篇: PreloadCaches - 预热URL