公共请求参数
公共请求参数是指每一个接口都需要使用到的参数:
名称 | 类型 | 必填项 | 描述 |
Format | String | 否 | 返回值的类型,支持JSON与XML,默认为XML。 |
Version | String | 是 | API版本号,为日期形式:YYYY-MM-DD,本版本对应为2017-07-11。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥ID,或者从您的业务服务器获取到的临时访问凭证中的临时密钥ID。 |
Signature | String | 是 | 签名结果串,关于签名的计算方法,请参见签名机制。 |
SignatureMethod | String | 是 | 签名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ例如,2014-7-29T12:00:00Z(为北京时间2014年7月29日的20点0分0秒。 |
SignatureVersion | String | 是 | 签名算法版本,目前版本是1.0。 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。 |
SecurityToken | String | 是(特定情况) | STS凭证,如果客户端从业务服务器获取STS凭证后访问智能云相册服务,该参数为必选。 |
LibraryId | String | 是(特定情况) | 照片库的Id,如果使用AK认证的方式来对照片库进行操作,该参数为必选。如果使用STS认证的方式,LibraryId是通过SecurityToken中的RoleSessionName来进行传递,此时该参数为可选,如果提供了该参数,那么其值需要和RoleSessionName一致。 |
http://cloudphoto.cn-shanghai.aliyuncs.com/
?Format=json
&Version=2017-07-11
&Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
&SignatureVersion=1.0
&Action=ListPhotos
&AccessKeyId=tkHh5O7431CgWayx
&Timestamp=2017-07-29T09%3A22%3A32Z
&SecurityToken=<SecurityTokenFromBusinessServer>
<?xml version="1.0" encoding="UTF-8"?>
<!—结果的根结点-->
<接口名称+Response> <!—返回请求标签-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!—返回结果数据-->
</接口名称+Response>
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回结果数据 */
}
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
在阿里云的API调用中,公共请求参数是构成每一个API请求不可或缺的部分,它们确保了请求的安全性、版本控制以及格式规范等。您已经列举了一部分关键的公共请求参数及其说明,这里我将为您提供一个更清晰的总结和示例:
Format:
JSON
与XML
,默认为XML
。Version:
YYYY-MM-DD
,例如2017-07-11
。AccessKeyId:
Signature:
SignatureMethod:
HMAC-SHA1
。Timestamp:
2014-7-29T12:00:00Z
。SignatureVersion:
1.0
。SignatureNonce:
SecurityToken (特定情况):
LibraryId (特定情况):
基于上述参数,一个典型的API请求URL示例可能如下所示(注意替换<>内的内容为实际值):
http://cloudphoto.cn-shanghai.aliyuncs.com/?Action=ListLibraries
&Format=json
&Version=2017-07-11
&AccessKeyId=<YourAccessKeyId>
&SignatureMethod=HMAC-SHA1
&Timestamp=2023-04-01T12:00:00Z
&SignatureVersion=1.0
&Signature=<GeneratedSignature>
&SignatureNonce=<RandomNonce>
请注意,具体到每个API,还会有特定的Action和可能的其他业务参数需要添加到URL中。此外,生成Signature
需要按照阿里云提供的签名算法进行计算,确保所有参数(包括非空的公共请求参数和业务参数)按规则排序并参与签名过程。