调用PollTaskResult获取已经执行完成(包含执行成功和执行失败并超过重试次数)的域名任务详情列表。
该接口需要配合AcknowledgeTaskResult确认任务结果。任务结果确认后,对应任务记录将无法从该接口查询到。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | PollTaskResult |
系统规定参数。取值:PollTaskResult。 |
UserClientIp | String | 否 | 127.0.0.1 |
用户IP,可设置为127.0.0.1。 |
Lang | String | 否 | en |
接口返回错误信息语言。取值:
默认为en。 |
TaskNo | String | 否 | 75addb07-28a3-450e-b5ec-test |
任务编号。 |
DomainName | String | 否 | example.com |
域名。 |
InstanceId | String | 否 | S20181T0WLI85212 |
域名实例编号。 信息模板创建成功后由系统自动生成,您可以调用QueryRegistrantProfiles接口查询信息模板编号。 |
TaskResultStatus | Integer | 否 | 2 |
任务结果类型,取值:
|
PageNum | Integer | 是 | 1 |
页码。 |
PageSize | Integer | 是 | 20 |
分页大小。最大值为1000。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PrePage | Boolean | false |
是否有上一页。 |
CurrentPageNum | Integer | 1 |
当前页码。 |
RequestId | String | E879DC07-38EE-4408-9F33-73B30CD965CD |
唯一请求识别码。 |
PageSize | Integer | 1 |
分页大小。 |
TotalPageNum | Integer | 10 |
总页数。 |
Data | Array of TaskDetail |
任务详情列表。 |
|
TaskDetail | |||
UpdateTime | String | 2018-03-26 15:22:18 |
最近一次任务详情执行时间。 |
TaskDetailNo | String | 15fee9d10d514bada66bd08c5723c583 |
任务详情编号。 |
CreateTime | String | 2018-03-26 15:08:20 |
任务创建时间。 |
InstanceId | String | S201817141000000 |
域名实例编号。 |
DomainName | String | example.com |
域名。 |
TaskType | String | CHG_DNS |
任务类型。 |
TaskNo | String | b95bc334-f7d8-4f39-8a62-4c4302a243d8 |
任务编号。 |
TaskResult | String | test |
任务结果。 |
TaskStatusCode | Integer | 2 |
任务状态码。可能值:
|
TaskStatus | String | EXECUTE_SUCCESS |
任务状态。可能值:
|
TaskTypeDescription | String | 修改DNS |
任务类型描述。如果切换了Lang参数,该字段会切换语言。 |
TryCount | Integer | 0 |
任务详情重试次数。 |
ErrorMsg | String | The operation is successful. |
任务执行失败消息。 |
TotalItemNum | Integer | 10 |
总条数。 |
NextPage | Boolean | false |
是否有下一页。 |
示例
请求示例
http(s)://[Endpoint]/?Action=PollTaskResult
&PageNum=1
&PageSize=20
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<PollTaskResultResponse>
<Data>
<TaskDetail>
<TryCount>0</TryCount>
<TaskDetailNo>15fee9d10d514bada66bd08c5723c583</TaskDetailNo>
<TaskNo>b95bc334-f7d8-4f39-8a62-4c4302a243d8</TaskNo>
<CreateTime>2018-03-26 15:08:20</CreateTime>
<InstanceId>S201817141000000</InstanceId>
<UpdateTime>2018-03-26 15:22:18</UpdateTime>
<TaskStatus>EXECUTE_SUCCESS</TaskStatus>
<DomainName>example.com</DomainName>
<TaskTypeDescription>DNS Modification</TaskTypeDescription>
<TaskStatusCode>2</TaskStatusCode>
<ErrorMsg>The operation is successful.</ErrorMsg>
<TaskType>CHG_DNS</TaskType>
</TaskDetail>
</Data>
<TotalItemNum>10</TotalItemNum>
<PageSize>1</PageSize>
<CurrentPageNum>1</CurrentPageNum>
<RequestId>C2CB6161-7971-4EB6-BC16-92A2BA3816D9</RequestId>
<TotalPageNum>10</TotalPageNum>
</PollTaskResultResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"CurrentPageNum" : 1,
"Data" : {
"TaskDetail" : [ {
"CreateTime" : "2018-03-26 15:08:20",
"DomainName" : "example.com",
"ErrorMsg" : "The operation is successful.",
"InstanceId" : "S201817141000000",
"TaskDetailNo" : "15fee9d10d514bada66bd08c5723c583",
"TaskNo" : "b95bc334-f7d8-4f39-8a62-4c4302a243d8",
"TaskStatus" : "EXECUTE_SUCCESS",
"TaskStatusCode" : 2,
"TaskType" : "CHG_DNS",
"TaskTypeDescription" : "DNS Modification",
"TryCount" : 0,
"UpdateTime" : "2018-03-26 15:22:18"
} ]
},
"PageSize" : 1,
"RequestId" : "E879DC07-38EE-4408-9F33-73B30CD965CD",
"TotalItemNum" : 10,
"TotalPageNum" : 10
}
错误码
访问错误中心查看更多错误码。