全部产品
Search
文档中心

查询已经执行完成的任务详情列表

更新时间: 2018-04-10

描述

获取已经执行完成(包括执行成功和执行失败并超过重试次数)的域名任务详情列表。该接口需要配合 AcknowledgeTaskResult 确认任务结果。任务结果确认后对应任务记录将无法从该接口查询到。

请求参数

参数 类型 是否必选 示例值 描述
PageNum Integer 1

页码。

PageSize Integer 20

分页大小。

DomainName String test.com

域名。

InstanceId String S20181T0WLI85212

业务编号。

Lang String en

接口返回错误信息语言,枚举值范围:zh 中文;en 英文。默认为en。

TaskNo String 75addb07-28a3-450e-b5ec-test

任务编号。

TaskResultStatus Integer 2

任务结果类型,枚举值范围:2 成功;3 失败。

UserClientIp String 127.0.0.1

用户IP。

返回参数

参数 类型 示例值 描述
RequestId String E879DC07-38EE-4408-9F33-73B30CD965CD

唯一请求识别码。

TotalItemNum Integer 10

总条数。

CurrentPageNum Integer 1

当前页码。

TotalPageNum Integer 10

总页数。

PageSize Integer 1

分页大小。

PrePage Boolean false

是否有上一页。

NextPage Boolean false

是否有下一页。

Data

任务详情列表。

  └TaskNo String b95bc334-f7d8-4f39-8a62-4c4302a243d8

任务编号。

  └TaskDetailNo String 15fee9d10d514bada66bd08c5723c583

任务详情编号。

  └TaskType String CHG_DNS

任务类型。

  └InstanceId String S201817141000000

域名实例编号。

  └DomainName String test.com

域名。

  └TaskStatus String EXECUTE_SUCCESS

任务状态。可能值:

  • WAITING_EXECUTE 等待执行
  • EXECUTING 执行中
  • EXECUTE_SUCCESS 执行成功
  • EXECUTE_FAILURE 执行失败
  └UpdateTime String 2018-03-26 15:22:18

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

  └CreateTime String 2018-03-26 15:08:20

任务创建时间。

  └TryCount Integer 0

任务详情重试次数。

  └ErrorMsg String The operation is successful.

任务执行失败消息。

  └TaskStatusCode Integer 2 任务状态码。可能值:
  • 0 等待执行
  • 1 执行中
  • 2 执行成功
  • 3 执行失败
  └TaskResult String test

任务结果。

  └TaskTypeDescription String 修改DNS

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

示例

请求示例

  1. /?Action=PollTaskResult
  2. &PageNum=1
  3. &PageSize=20
  4. &DomainName=test.com
  5. &InstanceId=S20181T0WLI85212
  6. &TaskNo=75addb07-28a3-450e-b5ec-test
  7. &TaskResultStatus=2
  8. &TaskType=1
  9. &<公共请求参数>

正常返回示例

  • XML 格式
  1. <PollTaskResultResponse>
  2. <Data>
  3. <TaskDetail>
  4. <TryCount>0</TryCount>
  5. <TaskDetailNo>15fee9d10d514bada66bd08c5723c583</TaskDetailNo>
  6. <TaskNo>b95bc334-f7d8-4f39-8a62-4c4302a243d8</TaskNo>
  7. <CreateTime>2018-03-26 15:08:20</CreateTime>
  8. <InstanceId>S201817141000000</InstanceId>
  9. <UpdateTime>2018-03-26 15:22:18</UpdateTime>
  10. <TaskStatus>EXECUTE_SUCCESS</TaskStatus>
  11. <DomainName>test.com</DomainName>
  12. <TaskTypeDescription>DNS Modification</TaskTypeDescription>
  13. <TaskStatusCode>2</TaskStatusCode>
  14. <ErrorMsg>The operation is successful.</ErrorMsg>
  15. <TaskType>CHG_DNS</TaskType>
  16. </TaskDetail>
  17. </Data>
  18. <TotalItemNum>10</TotalItemNum>
  19. <PageSize>1</PageSize>
  20. <CurrentPageNum>1</CurrentPageNum>
  21. <RequestId>C2CB6161-7971-4EB6-BC16-92A2BA3816D9</RequestId>
  22. <TotalPageNum>10</TotalPageNum>
  23. </PollTaskResultResponse>
  • JSON 格式
  1. {
  2. "CurrentPageNum":1,
  3. "Data":{
  4. "TaskDetail":[{
  5. "CreateTime":"2018-03-26 15:08:20",
  6. "DomainName":"test.com",
  7. "ErrorMsg":"The operation is successful.",
  8. "InstanceId":"S201817141000000",
  9. "TaskDetailNo":"15fee9d10d514bada66bd08c5723c583",
  10. "TaskNo":"b95bc334-f7d8-4f39-8a62-4c4302a243d8",
  11. "TaskStatus":"EXECUTE_SUCCESS",
  12. "TaskStatusCode":2,
  13. "TaskType":"CHG_DNS",
  14. "TaskTypeDescription":"DNS Modification",
  15. "TryCount":0,
  16. "UpdateTime":"2018-03-26 15:22:18"
  17. }]
  18. },
  19. "PageSize":1,
  20. "RequestId":"E879DC07-38EE-4408-9F33-73B30CD965CD",
  21. "TotalItemNum":10,
  22. "TotalPageNum":10
  23. }

异常返回示例

  • XML 格式
  1. <Error>
  2. <RequestId>3D864CDF-026E-45FE-99C8-B31D0E6A775A</RequestId>
  3. <HostId>domain.aliyuncs.com</HostId>
  4. <Code>MissingPageSize</Code>
  5. <Message>PageSize is mandatory for this action.</Message>
  6. <Recommend><![CDATA[https://error-center.aliyun.com/status/search?Keyword=MissingPageSize&source=PopGw]]></Recommend>
  7. </Error>
  • JSON 格式
  1. {
  2. "Code":"MissingPageSize",
  3. "HostId":"domain.aliyuncs.com",
  4. "Message":"PageSize is mandatory for this action.",
  5. "Recommend":"https://error-center.aliyun.com/status/search?Keyword=MissingPageSize&source=PopGw",
  6. "RequestId":"85A308D1-F383-4552-B9E7-8D312218D434"
  7. }

错误码

查看本产品错误码