所有的返回数据都会带上RequestId
,Action
,Version
,Service
,Region
这几个字段。
接口调用成功后会返回请求ID和接口返回参数,我们称这样的返回为正常返回。正常返回HTTP
状态码为2xx
。
以调用CreateDirectConnectGateway为例,正常的返回示例如下:
{ "ResponseMetadata": { "RequestId": "202111161611080102121461940900****", //RequestId为每次API请求的唯一标识。 "Action": "CreateDirectConnectGateway", //请求的API名称,属于请求的公共参数。 "Version": "2020-04-01", //请求的版本号。 "Service": "directconnect", //请求的服务。 "Region": "cn-beijing" //请求的地域。 }, "Result": { "RequestId": "202111161611080102121461940900****", "DirectConnectGatewayId": "dcg-7qthudw0ll6jmc****" //返回的结果。 } }
请求被正常处理后,返回中会包含ResponseMetadata
和Result
两部分,字段解释如下:
字段 | 解释 |
---|---|
RequestId | RequestId为每次API请求的唯一标识。 |
Action | 请求的接口名,属于请求的公共参数。 |
Version | 请求的版本号,属于请求的公共参数。 |
Service | 请求的服务,属于请求的公共参数。 |
说明
Result视请求的接口而定,不同的接口会有不同的Result返回。
接口调用出错后,会返回请求ID和错误信息,我们称这样的返回为异常返回。异常返回的HTTP
状态码为4xx
或者5xx
。您可以根据接口错误代码(Code
)和错误信息(Message
),参考公共错误码和接口错误码排查错误。
以调用CreateDirectConnectGateway为例,异常的返回示例如下:
{ "ResponseMetadata": { "RequestId": "202111161611080102121461940900****", "Action": "CreateDirectConnectGateway", "Version": "2020-04-01", "Service": "directconnect", "Region": "cn-beijing", "Error": { "Code": "UnsupportedOperation", "Message": "The request on the specified instance is denied due to the account in arrears status. " } } }
相较于正常返回结果,异常结果将不再有Result
部分,而ResponseMetadata
中将额外出现Error
字段,字段解释如下:
字段 | 解释 |
---|---|
Error | Error出现表明本次请求失败。 |
Code | Code内容为具体的错误码,您可查询对应API的错误码文档,自助解决问题。 |
CodeN | CodeN为标识错误码的数字ID,方便查找问题,仅部分接口会提供CodeN。 |
Message | Message描述了错误发生的具体原因。 |
RequestId | RequestId是每次API请求的唯一标识,当出现了无法自助解决的问题时,您可通过工单系统联系我们,提供请求的RequestID,我们将协助进行故障排查。 |