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

返回结构

最近更新时间2023.02.22 17:39:17

首次发布时间2021.12.02 18:50:05

以请求访问控制GetUser接口为例,成功结果和错误结果示例如下:

成功结果

{
    "ResponseMetadata": {
        "RequestId": "202112021830130102252430810768****",
        "Action": "GetUser",
        "Version": "2018-01-01",
        "Service": "iam"
    },
    "Result": {
        "User": {
            "CreateDate": "20210428T023119Z",
            "UpdateDate": "20211124T100123Z",
            "Status": "active",
            "AccountId": 20000*****,
            "UserName": "demo****",
            "Description": "",
            "DisplayName": "",
            "Email": "******",
            "EmailIsVerify": false,
            "MobilePhone": "******",
            "MobilePhoneIsVerify": false,
            "Trn": "trn:iam::20000*****:user/demo****"
        }
    }
}

请求被正常处理后,返回中会包含ResponseMetadataResult两部分,字段解释如下:

字段解释
RequestIDRequestID为每次API请求的唯一标识。
Action请求的接口名,属于请求的公共参数。
Version请求的版本号,属于请求的公共参数。
Service请求的服务,属于请求的公共参数。

Result视请求的接口而定,不同的接口会有不同的Result返回。

错误结果

调用失败的返回如下:

{
    "ResponseMetadata": {
        "RequestId": "20211202183645010225243125026D****",
        "Action": "GetUser",
        "Version": "2018-01-01",
        "Service": "iam",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100010,
            "Code": "SignatureDoesNotMatch",
            "Message": "The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details."
        }
    }
}

相较于成功结果,错误结果将不再有Result部分,而ResponseMetadata中将额外出现Error字段,字段解释如下:

字段解释
ErrorError出现表明本次请求失败。
CodeCode内容为具体的错误码,您可根据错误码查询文档自助解决问题。
CodeNCodeN为标识错误码的数字ID,方便查找问题,仅部分接口会提供CodeN。
MessageMessage描述了错误发生的具体原因,供您排查问题参考。
RequestIDRequestID是每次API请求的唯一标识,当出现了无法自助解决的问题时,您可通过工单系统联系我们,提供请求的RequestID,我们将协助进行故障排查。