返回结果
正确的返回结果
以查询云服务器列表(DescribeInstances)的接口为例,若调用成功,其可能返回如下:
{
"RequestId": "730a0a90-bcaf-11ed-8dde-06dde3cb088a",
"Total": 3,
"Items": []
}
- RequestId 是固定的字段,无论请求成功与否,只要 API 处理了,则必定会返回。
- RequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。
- 除了固定的字段外,其余均为具体接口定义的字段,不同的接口所返回的字段参见接口文档中的定义。
错误返回结果
若调用失败,其返回值实例如下
{
"RequestId": "730a0a90-bcaf-11ed-8dde-06dde3cb088a",
"ErrMsg": "可用的地域找不到",
"Code": "AvailableRegionNotFound"
}
- ErrMsg 和 Code 的出现表示该请求失败,调用失败时这两个字段必定返回。
- RequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。
- ErrMsg 发生错误的具体原因,随着业务发展或体验优化,此文本可能会经常保持变更或更新,用户不应依赖这个返回值。
- Code 表示错误的具体错误码。