You need to enable JavaScript to run this app.
导航
返回结构
最近更新时间:2024.06.18 14:18:48首次发布时间:2021.11.18 18:17:38

镜像仓库 OpenAPI 的所有返回,都会带上 RequestId,Action,Version,Service,Region 这几个字段。

正常返回示例

接口调用成功后会返回请求 ID 和接口返回参数,我们称这样的返回为正常返回。正常返回 HTTP 状态码为 2xx。

{
    "ResponseMetadata": {
        "RequestId": "202004011722300102****", //从X-Top-Request-Id的Header获取。
        "Action": "{Action}",//从请求Action的query获取。
        "Version": "{Version}",//从请求Version的query获取。
        "Service": "{Service}",//从X-Top-Service的header获取。
        "Region": "{Region}" //从X-Top-Region的header获取。
    },
    "Result":"..."
}

异常返回示例

接口调用出错后,会返回请求 ID 和错误信息,我们称这样的返回为异常返回。异常返回的 HTTP 状态码为 4xx 或者 5xx。

您可以根据接口错误代码(Code)和错误信息(Message),参考公共错误码和接口错误码排查错误。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
        "Error": {
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation GetUserById for version 2020-04-01"
        }
    }
}