调用PollTaskResult获取已经执行完成(包含执行成功和执行失败并超过重试次数)的域名任务详情列表。
接口说明
该接口需要配合 AcknowledgeTaskResult 确认任务结果。任务结果确认后,对应任务记录将无法从该接口查询到。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
domain:QueryDomainTask |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UserClientIp |
string |
否 |
用户 IP,可设置为127.0.0.1。 |
127.0.0.1 |
| Lang |
string |
否 |
接口返回错误信息语言。取值:
默认为 en。 |
en |
| TaskNo |
string |
否 |
任务编号。 |
75addb07-28a3-450e-b5ec-test |
| DomainName |
string |
否 |
域名。 |
example.com |
| InstanceId |
string |
否 |
域名实例编号。 信息模板创建成功后由系统自动生成,您可以调用 QueryRegistrantProfiles 接口查询信息模板编号。 |
S20181T0WLI85212 |
| TaskResultStatus |
integer |
否 |
任务结果类型,取值:
|
2 |
| PageNum |
integer |
是 |
页码。 |
1 |
| PageSize |
integer |
是 |
分页大小。最大值为 1000。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| CurrentPageNum |
integer |
当前页码。 |
1 |
| Data |
object |
||
| TaskDetail |
array<object> |
任务详情列表。 |
|
|
object |
|||
| CreateTime |
string |
任务创建时间。 |
2018-03-26 15:08:20 |
| DomainName |
string |
域名。 |
example.com |
| ErrorMsg |
string |
任务执行失败消息。 |
The operation is successful. |
| InstanceId |
string |
域名实例编号。 |
S201817141000000 |
| TaskDetailNo |
string |
任务详情编号。 |
15fee9d10d514bada66bd08c5723c583 |
| TaskNo |
string |
任务编号。 |
b95bc334-f7d8-4f39-8a62-4c4302a243d8 |
| TaskResult |
string |
任务结果。 |
test |
| TaskStatus |
string |
任务状态。可能值:
|
EXECUTE_SUCCESS |
| TaskStatusCode |
integer |
任务状态码。可能值:
|
2 |
| TaskType |
string |
任务类型。 |
CHG_DNS |
| TaskTypeDescription |
string |
任务类型描述。如果切换了 Lang 参数,该字段会切换语言。 |
修改DNS |
| TryCount |
integer |
任务详情重试次数。 |
0 |
| UpdateTime |
string |
最近一次任务详情执行时间。 |
2018-03-26 15:22:18 |
| NextPage |
boolean |
是否有下一页。 |
false |
| PageSize |
integer |
分页大小。 |
1 |
| PrePage |
boolean |
是否有上一页。 |
false |
| RequestId |
string |
唯一请求识别码。 |
E879DC07-38EE-4408-9F33-73B30CD965CD |
| TotalItemNum |
integer |
总条数。 |
10 |
| TotalPageNum |
integer |
总页数。 |
10 |
示例
正常返回示例
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",
"TaskResult": "test",
"TaskStatus": "EXECUTE_SUCCESS",
"TaskStatusCode": 2,
"TaskType": "CHG_DNS",
"TaskTypeDescription": "修改DNS",
"TryCount": 0,
"UpdateTime": "2018-03-26 15:22:18"
}
]
},
"NextPage": false,
"PageSize": 1,
"PrePage": false,
"RequestId": "E879DC07-38EE-4408-9F33-73B30CD965CD",
"TotalItemNum": 10,
"TotalPageNum": 10
}
异常返回示例
JSON格式
{
"CurrentPageNum":1,
"Data":{
"TaskDetail":[{
"CreateTime":"2018-03-26 15:08:20",
"DomainName":"test.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
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。