公共返回参数

最近更新时间:2017-12-06 11:25:20

公共返回参数是每次调用云API都会返回的参数,在各个接口的文档中对这些参数均进行了说明。公共返回参数具体列表如下:

名称 类型 描述
code Int 云API调用错误码。若为0,则表示API调用成功;否则,表示调用失败,请查询 错误码页面查看详细信息。
message String 具体的错误信息,根据各个接口的不同而不同。

查询伸缩组列表(DescribeScalingGroup)为例,API调用成功和失败的公共返回参数可能如下:

1、API调用成功的公共返回参数

若API调用成功,则公共返回参数具有如下格式:

{
    "code":"0",
    "message":"",
        <指令返回参数>
}

其中错误码code为0,表示API调用成功。此外,由于API调用成功,则错误信息字段message为空。

2、API调用失败的公共返回参数

若API调用失败,则公共返回参数具有如下格式:

{
    "code":"XXXX",
    "message":"(XXXX)XXXXX",
        <指令返回参数>
}

其中错误码code不为0,表示API调用失败。此外,由于API调用失败,则message字段不为空,会显示具体的错误信息。