预热历史查询

最近更新时间:2019-09-06 19:08:35

1. 接口描述

接口请求域名: cdn.tencentcloudapi.com 。

DescribePushTasks 用于查询预热任务提交历史记录及执行进度。(接口尚在批量公测中,暂未全量开放使用)

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePushTasks
Version String 公共参数,本接口取值:2018-06-06
Region String 公共参数,本接口不需要传递此参数。
StartTime Timestamp 开始时间,如2018-08-08 00:00:00。
EndTime Timestamp 结束时间,如2018-08-08 23:59:59。
TaskId String 提交时返回的任务 Id,查询时 TaskId 和起始时间必须指定一项。
Keyword String 查询关键字,请输入域名或 http(s):// 开头完整 URL。
Offset Integer 分页查询偏移量,默认为 0 (第一页)。
Limit Integer 分页查询限制数目,默认为20。
Area String 查询刷新记录指定地区。mainland:中国大陆。
Status String 查询指定任务状态,fail表示失败,done表示成功,process表示刷新中。

3. 输出参数

参数名称 类型 描述
PushLogs Array of PushTask 预热历史记录
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 任务总数,用于分页
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 预热历史查询

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribePushTasks
&TaskId=1533031853231313311
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
    "PushLogs": [
      {
        "TaskId": "1533031853231313311",
        "Url": "http://www.test.com/",
        "Status": "Done",
        "Percent": 100,
        "CreateTime": "2018-07-30 18:10:53"
      }
    ],
    "TotalCount": 20
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查
InvalidParameter.CdnHostInvalidParam 域名格式不合法,请确认后重试
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例
InvalidParameter.CdnStatInvalidMetric 统计类型不合法,请参考文档中统计分析示例
InvalidParameter.CdnStatInvalidProjectId 项目ID错误,请确认后重试
LimitExceeded.CdnHostOpTooOften 域名操作过于频繁。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口
ResourceUnavailable.CdnHostIsNotOnline 域名已下线,无法提交预热
UnauthorizedOperation.CdnUserAuthFail CDN用户认证失败。
UnauthorizedOperation.CdnUserAuthWait CDN用户待认证。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限