查询异步请求任务状态
更新时间：2023-04-15 02:52:35
适用产品
网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、上网加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、应用加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案
接口描述
对于域名的新增、修改、启用、禁用、取消、恢复、删除等请求
- 调用URL： https://open.chinanetcenter.com/api/request/*
- 调用方法：POST,GET
- 限制说明：• 接口返回结果仅支持xml格式。
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Path 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
cnc-request-id | String | 是 | 对于账号每一次请求记录，都会生成唯一的cnc-request-id（适用全部接口），通过该id可以查询每次异步请求任务的执行结果 |
Body 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
cncCequestId | String | 是 | 对于账号每一次请求记录，都会生成唯一的cnc-request-id（适用全部接口），通过该id可以查询每次异步请求任务的执行结果 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
http-status-code | Integer | httpstatus=202; 表示成功调用新增域名接口，可使用header中的x-cnc-request-id查看当前新增域名的部署情况 |
x-cnc-request-id | String | 唯一标示的id，用于查询每次请求的任务 （适用全部接口） |
cnc-request-id | String | 本次想要查询的请求记录对应的cnc-request-id |
timestamp | String | 本次想要查询的请求记录的提交时间，例如：Thu,09 Nov 2017 22:37:53 CST |
async-result | String | 异步请求的任务执行结果，包括以下4种状态： WAIT：表示该请求等待执行 INPROGRESS：表示该请求执行中 SUCCESS：表示该请求已经执行成功 FAIL：表示该请求执行失败 注意： 1.新建域名的异步请求任务，通过本接口如果查询到结果是执行失败，系统后台会会有重提机制或者人工干预，直到部署成功。 2.修改域名配置的异步请求任务，和新增域名一样，也会有重提机制和人工干预。 |
async-message | String | 异步请求的任务执行结果的更多相关信息 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| NoSuchRequestID | The specified request id does not exist. | 404 | 请求任务ID不存在 |
示例
XML
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://open.chinanetcenter.com/api/request/d845d239-27d6-43e4-a8ea-a994df006256" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/xml"
- 返回示例 复制成功
HTTP/1.1 200 Accepted Date: Fri, 17 May 2017 06:33:26 GMT Content-Type: application/xml;charset=utf-8 x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd <request-log> <cnc-request-id>d845d239-27d6-43e4-a8ea-a994df006256</cnc-request-id> <timestamp>Wed, 22 Nov 2017 16:33:36 CST</timestamp> <async-result>SUCCESS</async-result> <async-message/> </request-log>
本篇文档内容对您是否有帮助？
有帮助
我要反馈