公共返回参数
公共返回参数是指每次请求都会返回的参数
名称 | 类型 | 描述 |
RequestId | String | 用户每次请求,无论成功与否(系统超时:10秒),系统都会返回一个唯一识别码RequestId给用户,根据RequestId可以快速的排查问题 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
公共返回参数是每次API请求后系统必定返回的一组信息,它帮助用户识别请求状态、追踪请求历史及排查问题。关键参数说明如下:
RequestId
给用户。利用这个识别码,用户可以快速定位并分析请求的具体情况。XML示例:
<?xml version="1.0" encoding="UTF-8"?>
<接口名称+Response>
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!-- 返回结果数据 -->
</接口名称+Response>
JSON示例:
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* 返回结果数据 */
}
当遇到错误时,返回结构同样包含RequestId
,并会提供额外的错误信息以供定位问题:
错误结果示例:
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
<Code>InvalidAccessKeyId.NotFound</Code>
<Message>The Access Key ID provided does not exist in our records.</Message>
</Error>
{
"RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
"Code": "InvalidAccessKeyId.NotFound",
"Message": "The Access Key ID provided does not exist in our records."
}
通过这些返回参数,调用者可以根据每个接口特定的错误码(Code
)和错误信息(Message
)来确定请求失败的具体原因,并结合RequestId
进行更深入的问题追踪与解决。