公共请求参数
公共请求参数是指每个接口都需要使用到的请求参数。
名称 | 类型 | 是否必须 | 描述 |
Format | String | 否 | 返回值的类型,支持 JSON 与 XML。默认为 XML。 |
Version | String | 是 | API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2014-05-26。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥 ID。 |
Signature | String | 是 | 签名结果串,关于签名的计算方法,请参见<签名机制>。 |
SignatureMethod | String | 是 | 签名方式,目前支持 HMAC-SHA1。 |
Timestamp | String | 是 | 请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为: YYYY-MM-DDThh:mm:ssZ 例如,2014-05-26T12:00:00Z(为北京时间 2014 年 5 月 26 日 20 点 0 分 0 秒)。 |
SignatureVersion | String | 是 | 签名算法版本,目前版本是 1.0。 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值 |
ResourceOwnerAccount | String | 否 | 本次 API 请求访问到的资源拥有者账户,即登录用户名。 此参数的使用方法,详见< 借助 RAM 实现子账号对主账号的 ECS 资源访问>,(只能在 RAM 中可对 ECS 资源进行授权的 Action 中才能使用此参数,否则访问会被拒绝) |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
在阿里云的API请求中,公共请求参数是构建任何API调用的基础,确保了请求的安全性、版本控制以及格式规范。您提到的这些参数适用于多数阿里云服务的API调用,下面是对每个参数的简要说明及示例中的应用:
Format: 指定返回数据的格式,可选值为JSON
或XML
。在示例中,通过Format=xml
指定了响应格式为XML。如果不提供,默认为XML。
Version: 表示使用的API版本号,格式为YYYY-MM-DD
。这是非常重要的,因为不同的版本可能有不同的功能和行为。示例中没有直接展示Version参数,但在实际调用时必须包含,例如Version=2014-05-26
。
AccessKeyId: 阿里云账号的访问密钥ID,用于身份验证。每个阿里云用户都有自己的AccessKey对,包括AccessKeyId和AccessKeySecret。
Signature: 通过签名算法计算得出的字符串,用于验证请求的完整性和来源。它基于请求方法、请求URL、请求参数等信息和AccessKeySecret计算得到。
SignatureMethod: 签名所使用的加密算法,通常为HMAC-SHA1
。
Timestamp: 请求的时间戳,使用UTC时间,并遵循ISO8601标准格式,如2014-05-26T12:00:00Z
。这有助于防止重放攻击。
SignatureVersion: 签名算法的版本,一般为1.0
。
SignatureNonce: 一个随机字符串,确保每次请求的唯一性,防止重放攻击。
ResourceOwnerAccount: 在使用资源访问管理(RAM)进行权限控制时,可以指定本次请求操作资源所属的子账号用户名。如果未使用RAM或不涉及子账号权限,则可能不需要此参数。
示例中的URLhttps://ecs.aliyuncs.com/?Format=xml
仅展示了如何指定返回格式为XML,但完整的API调用URL还应包含其他必要的公共请求参数,特别是那些用于认证和安全的参数(如AccessKeyId、Signature等),以及特定于操作的业务参数。
为了构造一个完整的API请求URL,您需要根据阿里云文档提供的指南,结合具体的服务和操作,生成签名字符串并附加所有必需的参数。此外,推荐使用阿里云官方SDK来简化这个过程,因为SDK会自动处理签名、参数构造等复杂细节。
你好,我是AI助理
可以解答问题、推荐解决方案等