返回结构

发送请求消息以后，您会收到服务端的响应，返回结果中包含状态码、响应消息头和消息体。

状态码

状态码是一组从 1xx 到 5xx 的数字代码，状态码表示了请求响应的状态，例如响应的HTTPS状态码为 2xx，表示调用成功；返回的HTTPS状态码为 4xx 或 5xx，表示调用失败。
各接口的对应状态码请参考各个接口文档，通用状态码列表请参考状态码。

响应消息头

响应消息头通常包括以下公共参数。

返回消息头示例：

Content-Type:  application/json; charset=utf-8
Content-Length:  73    
Connection: keep-alive
X-Tls-Requestid:  3a********
Date:  Sun, 22 Aug 2021 02:10:34 GMT

响应消息体

响应消息体通常以 JSON 结构化格式返回，与响应消息头中 Content-Type 对应，传递除响应消息头之外的内容。当接口调用出错时，会返回错误码及错误信息说明。

• HTTP 状态码为 200，表示请求成功。此时服务端返回结果中会包含具体的业务信息，即各个 API 中独立定义的返回信息，详细说明请查看各个接口的 API 文档。

• 所有非 200 的状态码，表示请求失败。失败的详细信息以 JSON 的形式返回，返回内容中包含 ErrorCode 和 ErrorMessage 两部分。

  注意

  随着业务发展或体验优化，ErrorCode 和 ErrorMessage 的内容可能会随时更新，该内容仅供排查参考，请勿依赖该内容。

  字段	说明
  ErrorCode	具体的错误码，您可根据错误码查询文档自助解决问题。
  ErrorMessage	错误信息，描述了错误发生的具体原因，供您排查问题参考。

请求成功示例

{
    "Projects": [
        {
            "ProjectId": "6fd4bbb0-e0a9-454e-b165-5a640c85****",
            "ProjectName": "test3",
            "Description": "",
            "CreateTime": "2021-08-22T14:53:45Z",
            "TopicCount": 0,
            "InnerNetDomain": "tls-cn-beijing.ivolces.com"
        },
        {
            "ProjectId": "d1598af5-fa2d-4571-855e-c41d1114****",
            "ProjectName": "ffff",
            "Description": "",
            "CreateTime": "2021-08-20T14:37:20Z",
            "TopicCount": 0,
            "InnerNetDomain": "tls-cn-beijing.ivolces.com"
        }
    ],
    "Total": 30
}

请求失败示例

{
    "ErrorCode": "ProjectAlreadyExist",
    "ErrorMessage": "Project already exist"
}