AI 助理
备案控制台
开发者社区 问答 正文

公共参数应该如何使用？



公共请求参数


公共请求参数是指每个接口都需要使用到的请求参数。

名称类型是否必须描述
FormatString否返回值的类型，支持JSON与XML，默认为XML。
RegionIdString是当前请设置为cn-hangzhou
VersionString是API版本号，为日期形式YYYY-MM-DD，请参见概览。
AccessKeyIdString是阿里云颁发给用户的访问服务所用的密钥ID。
SignatureString是签名结果串，关于签名的计算方法，请参见 签名机制。
SignatureMethodString是签名方式，目前支持HMAC-SHA1。
TimestampString是请求的时间戳。日期格式按照ISO8601标准表示，并需要使用UTC时间，格式为YYYY-MM-DDThh:mm:ssZ，例如2016-02-25T12:00:00Z（为UTC时间2016年2月25日12点0分0秒）。
SignatureVersionString是签名算法版本，目前版本是1.0。
SignatureNonceString是唯一随机数，用于防止网络重放攻击，用户在不同请求间要使用不同的随机数值。


示例

  1. [backcolor=transparent]https[backcolor=transparent]:[backcolor=transparent]//cloudpush.aliyuncs.com/
  2. [backcolor=transparent]?[backcolor=transparent]Format[backcolor=transparent]=[backcolor=transparent]XML
  3. [backcolor=transparent]&[backcolor=transparent]RegionId[backcolor=transparent]=[backcolor=transparent]cn[backcolor=transparent]-[backcolor=transparent]hangzhou
  4. [backcolor=transparent]&[backcolor=transparent]Version[backcolor=transparent]=[backcolor=transparent]2016[backcolor=transparent]-[backcolor=transparent]08[backcolor=transparent]-[backcolor=transparent]01
  5. [backcolor=transparent]&[backcolor=transparent]AccessKeyId[backcolor=transparent]=[backcolor=transparent]testid
  6. [backcolor=transparent]&[backcolor=transparent]Signature[backcolor=transparent]=[backcolor=transparent]Pc5WB8gokVn0xfeu[backcolor=transparent]%[backcolor=transparent]2FZV[backcolor=transparent]%[backcolor=transparent]2BiNM1dgI[backcolor=transparent]%[backcolor=transparent]3D
  7. [backcolor=transparent]&[backcolor=transparent]SignatureMethod[backcolor=transparent]=[backcolor=transparent]HMAC[backcolor=transparent]-[backcolor=transparent]SHA1
  8. [backcolor=transparent]&[backcolor=transparent]SignatureNonce[backcolor=transparent]=[backcolor=transparent]15215528852396
  9. [backcolor=transparent]&[backcolor=transparent]SignatureVersion[backcolor=transparent]=[backcolor=transparent]1.0
  10. [backcolor=transparent]&[backcolor=transparent]Timestamp[backcolor=transparent]=[backcolor=transparent]2016[backcolor=transparent]-[backcolor=transparent]02[backcolor=transparent]-[backcolor=transparent]25T12[backcolor=transparent]:[backcolor=transparent]00[backcolor=transparent]:[backcolor=transparent]00Z
  11. [backcolor=transparent]&<接口相关参数>
  12. [backcolor=transparent]…


公共返回参数


用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码RequestId给用户。

XML示例

  1. [backcolor=transparent]<?[backcolor=transparent]xml version[backcolor=transparent]=[backcolor=transparent]"1.0"[backcolor=transparent] encoding[backcolor=transparent]=[backcolor=transparent]"UTF-8"[backcolor=transparent]?>
  2. [backcolor=transparent]<!—结果的根结点-->
  3. [backcolor=transparent]<接口名称+Response>
  4. [backcolor=transparent]    <!—返回请求标签-->
  5. [backcolor=transparent]    [backcolor=transparent]<RequestId>[backcolor=transparent]4C467B38-3910-447D-87BC-AC049166F216[backcolor=transparent]</RequestId>
  6. [backcolor=transparent]    <!—返回结果数据-->
  7. [backcolor=transparent]</接口名称+Response>


JSON示例

  1. [backcolor=transparent]{
  2. [backcolor=transparent]    [backcolor=transparent]"RequestId"[backcolor=transparent]:[backcolor=transparent] [backcolor=transparent]"4C467B38-3910-447D-87BC-AC049166F216"
  3. [backcolor=transparent]    [backcolor=transparent]/*[backcolor=transparent] [backcolor=transparent]返回结果数据[backcolor=transparent] [backcolor=transparent]*/
  4. [backcolor=transparent]}

展开
收起
猫饭先生 2017-10-23 10:25:16 1513 分享 版权

版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

阿里云 AI 助理回答

公共请求参数是调用阿里云API接口时必须提供的基础参数，确保每个请求都能被正确处理和认证。以下是这些参数的详细说明：

  • Format（格式）:

    • 类型: String
    • 是否必须: 否
    • 描述: 指定返回值的类型，支持JSON与XML，默认为XML。

  • RegionId（区域ID）:

    • 类型: String
    • 是否必须: 是
    • 描述: 表示服务所在地域，通常设置为cn-hangzhou，但根据具体服务可能有所不同。

  • Version（版本号）:

    • 类型: String
    • 是否必须: 是
    • 描述: API的版本号，采用日期形式YYYY-MM-DD，实际使用时需参照对应服务的文档要求。

  • AccessKeyId（访问密钥ID）:

    • 类型: String
    • 是否必须: 是
    • 描述: 阿里云颁发给用户的唯一标识，用于访问阿里云服务。

  • Signature（签名结果串）:

    • 类型: String
    • 是否必须: 是
    • 描述: 请求的签名结果，用于验证请求的完整性和来源，计算方法请参考相应签名机制文档。

  • SignatureMethod（签名方式）:

    • 类型: String
    • 是否必须: 是
    • 描述: 目前仅支持HMAC-SHA1作为签名算法。

  • Timestamp（时间戳）:

    • 类型: String
    • 是否必须: 是
    • 描述: 请求的时间戳，遵循ISO8601标准，格式为YYYY-MM-DDThh:mm:ssZ，需使用UTC时间。

  • SignatureVersion（签名版本）:

    • 类型: String
    • 是否必须: 是
    • 描述: 签名算法的版本，当前固定为1.0。

  • SignatureNonce（签名随机数）:

    • 类型: String
    • 是否必须: 是
    • 描述: 用于防止请求重放攻击的随机字符串，每次请求应使用不同的值。

示例请求URL展示了一个包含上述公共参数的实际应用样例，尽管直接URL在此未完全展示，其结构如下：

https://[服务域名]/
?Format=[返回格式]
&RegionId=[区域ID]
&Version=[API版本号]
&AccessKeyId=[用户AccessKeyId]
&Signature=[计算出的签名结果]
&SignatureMethod=HMAC-SHA1
&SignatureNonce=[生成的随机数]
&SignatureVersion=1.0
&Timestamp=[当前UTC时间戳]
&[其他特定接口参数]

请注意，实际使用时需根据所调用的服务文档来确定具体的参数值和格式要求。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确，仅供参考
0 条回答
写回答
取消 提交回答
问答分类：
XML JSON 算法 API 数据格式
问答地址：
开发者社区 > 开发与运维 > 问答
相关问答
this xml file does not appear to have any style in
47790
10
0
请问下 我访问接口不通 什么原因 Provisional headers are shown
1634
0
0
购买阿里国外的云服务器是否可以访问谷歌？
80395
47
0
通过www和不带www的网址输入最终都指向www.我的域名.com，求指教
123828
28
0
OSS的endpoint如何查看
36176
6
0
sql server的用户名和密码怎么查啊？
35486
21
0
配置了安全组规则，端口还是无法访问
32232
25
0
域名在腾讯云备案成功，解析到阿里云服务器，提示仍需备案？
59443
30
0
设置域名解析如何指向我的服务器url包括端口号
17535
2
0
Connection reset by peer的常见原因及解决办法
3728
1
0