文档中心 云解析 API 文档 调用方式 返回结果 异步任务接口返回格式

异步任务接口返回格式

最近更新时间:2019-08-09 18:33:58

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

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

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

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

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

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

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

例如:

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

注意:

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