异步任务接口返回格式

最近更新时间:2017-07-17 20:57:02

  • 在新版 API( 当前仅部分业务,如CVM ) 中并没有对异步任务接口的概念定义,具体使用方式会在各个 Action 文档中进行进一步的声明。

1. 普通异步任务接口返回格式

一次请求只能操作一个资源的异步任务接口,例如创建负载均衡,重置主机操作系统等。

名称 类型 描述 必选
code Int 返回结果的错误码,0表示成功,其它值表示失败。 Yes
message String 返回结果的错误信息 No
requestId String 任务编号 Yes

2. 批量异步任务接口返回格式

一次请求能操作多个资源的异步任务接口,例如修改密码,启动机器,停止机器等。

名称 类型 描述 必选
code Int 返回结果的错误码,0表示成功,其它值表示失败。 Yes
message String 返回结果的错误信息 No
detail Array 以资源ID为key, 返回对该资源操作的code,message,requestId Yes

例如:

{
        "code":0,
        "message": "success",
        "detail":
        {
             "qcvm6a456b0d8f01d4b2b1f5073d3fb8ccc0":
            {
             "code":0,
             "message":"",
             "requestId":"1231231231231":,
            }
              "qcvm6a456b0d8f01d4b2b1f5073d3fb8ccc0":
            {
              "code":0,
              "message":"",
              "requestId":"1231231231232":,
            }
        }
}

注意:
资源全部操作成功,则最外层code为0
资源全部操作失败,则最外层code会返回5100
资源部分操作失败,则最外层code会返回5400
在第3种情况下,终端可以通过detail得到失败部分的操作信息。

如果有其他疑问,你也可以通过提问形式与我们联系探讨