文档

PollTaskResult - 获取执行完成任务详情

更新时间:

调用PollTaskResult获取已经执行完成(包含执行成功和执行失败并超过重试次数)的域名任务详情列表。

接口说明

该接口需要配合 AcknowledgeTaskResult 确认任务结果。任务结果确认后,对应任务记录将无法从该接口查询到。

调试

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

授权信息

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

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

请求参数

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

用户 IP,可设置为127.0.0.1

127.0.0.1
Langstring

接口返回错误信息语言。取值:

  • zh:中文。
  • en:英文。

默认为 en

en
TaskNostring

任务编号。

75addb07-28a3-450e-b5ec-test
DomainNamestring

域名。

example.com
InstanceIdstring

域名实例编号。

信息模板创建成功后由系统自动生成,您可以调用 QueryRegistrantProfiles 接口查询信息模板编号。

S20181T0WLI85212
TaskResultStatusinteger

任务结果类型,取值:

  • 2:成功。
  • 3:失败。
2
PageNuminteger

页码。

1
PageSizeinteger

分页大小。最大值为 1000

20

返回参数

名称类型描述示例值
object
PrePageboolean

是否有上一页。

false
CurrentPageNuminteger

当前页码。

1
RequestIdstring

唯一请求识别码。

E879DC07-38EE-4408-9F33-73B30CD965CD
PageSizeinteger

分页大小。

1
TotalPageNuminteger

总页数。

10
Dataobject []

任务详情列表。

UpdateTimestring

最近一次任务详情执行时间。

2018-03-26 15:22:18
TaskDetailNostring

任务详情编号。

15fee9d10d514bada66bd08c5723c583
CreateTimestring

任务创建时间。

2018-03-26 15:08:20
InstanceIdstring

域名实例编号。

S201817141000000
DomainNamestring

域名。

example.com
TaskTypestring

任务类型。

CHG_DNS
TaskNostring

任务编号。

b95bc334-f7d8-4f39-8a62-4c4302a243d8
TaskResultstring

任务结果。

test
TaskStatusCodeinteger

任务状态码。可能值:

  • 0:等待执行。
  • 1:执行中。
  • 2:执行成功。
  • 3:执行失败。
2
TaskStatusstring

任务状态。可能值:

  • WAITING_EXECUTE:等待执行。
  • EXECUTING:执行中。
  • EXECUTE_SUCCESS:执行成功。
  • EXECUTE_FAILURE:执行失败。
EXECUTE_SUCCESS
TaskTypeDescriptionstring

任务类型描述。如果切换了 Lang 参数,该字段会切换语言。

修改DNS
TryCountinteger

任务详情重试次数。

0
ErrorMsgstring

任务执行失败消息。

The operation is successful.
TotalItemNuminteger

总条数。

10
NextPageboolean

是否有下一页。

false

示例

正常返回示例

JSON格式

{
  "PrePage": false,
  "CurrentPageNum": 1,
  "RequestId": "E879DC07-38EE-4408-9F33-73B30CD965CD",
  "PageSize": 1,
  "TotalPageNum": 10,
  "Data": {
    "TaskDetail": [
      {
        "UpdateTime": "2018-03-26 15:22:18",
        "TaskDetailNo": "15fee9d10d514bada66bd08c5723c583",
        "CreateTime": "2018-03-26 15:08:20",
        "InstanceId": "S201817141000000",
        "DomainName": "example.com",
        "TaskType": "CHG_DNS",
        "TaskNo": "b95bc334-f7d8-4f39-8a62-4c4302a243d8",
        "TaskResult": "test",
        "TaskStatusCode": 2,
        "TaskStatus": "EXECUTE_SUCCESS",
        "TaskTypeDescription": "修改DNS",
        "TryCount": 0,
        "ErrorMsg": "The operation is successful."
      }
    ]
  },
  "TotalItemNum": 10,
  "NextPage": false
}

错误码

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

  • 本页导读 (1)