最近更新时间:2023.08.17 20:13:48
首次发布时间:2023.02.22 17:09:41
本文以 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
字段解释如下:
字段 | 说明 |
---|---|
RequestID | RequestID 为每次 API 请求的唯一标识。 |
Action | 请求的接口名,属于公共参数。 |
Version | 请求的版本号,属于公共参数。 |
Service | 请求的服务,属于公共参数。 |
接口调用失败的的返回结果示例如下:
{ "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。 |
Message | Message 描述了错误发生的具体原因,供您排查问题参考。 |
RequestID | RequestID 是每次 API 请求的唯一标识。当出现了无法自助解决的问题时,您可通过工单系统联系我们,并提供请求的RequestID,我们将协助进行问题排查。 |