返回结果

本文以 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****"
        }
    }
}

说明

接口调用成功后，返回结果中会包含 ResponseMetadata 和 Result 两部分。接口不同，返回的 Result 部分内容也会不同。ResponseMetadata 字段解释如下：

错误返回结果

示例

接口调用失败的的返回结果示例如下：

{
    "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 字段，字段解释如下：