以请求访问控制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
两部分,字段解释如下:
字段 | 解释 |
---|---|
RequestID | RequestID为每次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字段,字段解释如下:
字段 | 解释 |
---|---|
Error | Error出现表明本次请求失败。 |
Code | Code内容为具体的错误码,您可根据错误码查询文档自助解决问题。 |
CodeN | CodeN为标识错误码的数字ID,方便查找问题,仅部分接口会提供CodeN。 |
Message | Message描述了错误发生的具体原因,供您排查问题参考。 |
RequestID | RequestID是每次API请求的唯一标识,当出现了无法自助解决的问题时,您可通过工单系统联系我们,提供请求的RequestID,我们将协助进行故障排查。 |