You need to enable JavaScript to run this app.
导航

返回结果

最近更新时间2023.05.11 16:26:01

首次发布时间2023.05.11 16:17:40

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

状态码

状态码是一组从 1xx 到 5xx 的数字代码,状态码表示了请求响应的状态。

  • 状态码为 200 ,表示接口请求成功。
  • 返回所有非 200 的状态码,均表示接口请求失败。具体的失败信息,以 JSON 格式返回。

响应消息头

对应请求消息头,响应同样也有消息头,如 “Content-Type”。

响应消息体

响应消息体通常以 JSON 结构化格式返回,与响应消息头中 Content-Type 对应,传递除响应消息头之外的内容。

  • HTTP 状态码为 200,表示请求成功。此时服务端返回结果中包含 ResponseMetadataResult 两部分。
  • 所有非 200 的状态码,表示请求失败。失败信息以 JSON 格式返回,返回内容中必定出现 Error 字段,Error 字段中包含了CodeCodeNMessage字段。

请求成功返回示例

{
    "ResponseMetadata": {
        "RequestId": "202304181552473A5689B5D88D4D906179",
        "Action": "DescribeProject",
        "Version": "2021-06-01",
        "Service": "spark",
        "Region": "cn-beijing"
    },
    "Result": {
        "ProjectId": "qh8i**0xt",
        "ProjectName": "doc-test-project",
        "RegionId": "cn-beijing",
        "OwnerId": "6e2240691**92cc1517306a",
        "OwnerName": "openstudio-test",
        "Description": "文档测试项目!",
        "CreateDate": "2023-02-14 14:54:12"
    }
}

说明

  • ResponseMetadata 及其内部的 RequestId、Action、Version、Service、Region 是固定的字段,无论请求成功与否,只要发起了 API 请求,必定会返回。
  • RequestId 是一个 API 请求的唯一标识,如果 API 出现异常,您可以提交工单联系技术支持,并提供该 ID 来帮助定位问题。
  • Result 是固定字段,字段内容由不同的产品自行定义。

请求失败示例

{
    "ResponseMetadata": {
        "RequestId": "20230418155328B7AF65B396A8778D7D4D",
        "Action": "DescribeProject",
        "Version": "2022-06-01",
        "Service": "spark",
        "Region": "cn-beijing",
        "Error": {
            "CodeN": 100008,
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation DescribeProject for version 2022-06-01"
        }
    }
}

说明

  • 请求调用失败时,不会返回 Result 字段。
  • 请求调用失败时必定会出现 Error 字段,Error 字段中包含了 Code、CodeN 和 Message字段。
    • Code:表示具体出错的错误码,您可根据错误码自助解决问题。
    • CodeN:标识错误码的数字 ID,方便查找问题,仅部分接口会提供 CodeN。
    • Message:错误信息,描述了错误发生的具体原因,供您排查问题参考。随着业务发展或体验优化,此文本可能会经常保持变更或更新,不建议完全依赖这个返回值。