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

返回结果

最近更新时间2023.05.18 15:33:39

首次发布时间2022.05.26 14:18:32

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

状态码

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

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

消息头

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

响应消息体

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

  • ResponseMetadata:包含请求的接口信息例如 Action 和 service 等。
  • Result:请求返回的结果。Result 视请求的接口而定,不同的接口会有不同的 Result 返回。
    以访问控制服务的 ListFs 接口为例,请求成功时的返回结果为:
{
    "Result": {
        "Items": [
            {
                "Name": "doc-test-cfs-1",
                "Id": "180143***482812",
                "Status": "CREATING",
                "RegionId": "cn-beijing",
                "ZoneId": "cn-beijing-b",
                "Mode": "HDFS_MODE",
                "TosBucket": null,
                "TosPrefix": null,
                "CacheMode": null,
                "CachePlan": "DISABLED",
                "CacheCapacity": 0,
                "CacheCapacityTiB": 0,
                "CreatedTime": "2023-04-21T15:30:25",
                "NsQuota": 50,
                "NsCount": 1,
                "VpcId": null,
                "SecurityGroupId": null,
                "SubnetId": null,
                "MountPoint": null
            }
        ],
        "TotalSize": "1",
        "PageNumber": 0,
        "PageSize": 10
    },
    "ResponseMetadata": {
        "RequestId": "20230421153**8746BE3D3BED43",
        "Action": "ListFs",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

当接口调用出错时,会返回错误码及错误信息说明,错误响应的消息体格式如下所示。

{
    "ResponseMetadata": {
        "RequestId": "20230424151**01AEE70BC504E1B",
        "Action": "ListFs",
        "Version": "2023-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": {
            "CodeN": 100008,
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation ListFs for version 2023-02-02"
        }
    }
}

调用错误时的返回参数说明如下。

参数

说明

Code

具体的错误码,您可根据错误码查询文档自助解决问题。

CodeN

CodeN 为标识错误码的数字 ID,方便查找问题,仅部分接口会提供 CodeN。

Message

描述了错误发生的具体原因,供您排查问题参考。

RequestId

RequestId 是一个 API 请求的唯一标识,如果请求出现异常,您可以提交工单联系技术支持,并提供该 ID 来帮助定位问题。