云控制台API返回结果说明

云控制台API以JSON报文形式返回结果。返回结果使用UTF-8编码格式。

云控制台API返回结果包含公共信息部分和业务信息部分。公共信息部分为云控制台API强制返回的内容，包含了请求是否成功以及该请求的ID。业务信息部分由每个接口根据业务需求定义。

根据请求是否成功处理，业务信息会被区分为正常业务信息和异常业务信息两类。正常业务信息主要包含请求的业务结果数据；异常业务信息主要包含异常错误信息。

以下分别对接口返回公共信息和业务信息进行说明。

请注意：为了便于查看和美观，本文档返回示例中均有换行和缩进等处理，实际返回结果无换行和缩进处理。

1. 公共信息

公共信息是指云控制台API调用返回结果的公共部分，任何接口调用的返回都包含公共信息部分。公共信息字段包括:

2. 正常业务信息

接口调用成功后会返回接口调用结果、返回信息和请求ID，我们称这样的返回为正常返回。正常返回的HTTP状态码为 2xx。

3. 异常业务信息

接口调用出错后，会返回错误码、错误信息和请求ID，我们称这样的返回为异常返回。HTTP 状态码为 4xx 、 5xx 或者 6xx。 您可以根据接口错误码以及公共错误码排查错误。

4. 返回结果示例

以下为创建云主机的正常返回结果内容：

{
  "requestId": "5baa5046-7758-49fd-b617-2c4ace1be375",
  "success": true,
  "code": 200,
  "message": null,
  "model": null
}

以下为创建云主机的异常返回结果内容：

{
    "requestId": "4416235a-e9c0-453f-823a-ad491ebd74ab",
    "success": false,
    "code": 403,
    "message": "permission denied"
}