开发者社区 问答 正文

智能云相册中的公共请求参数类型



公共请求参数


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

名称类型必填项描述
FormatString返回值的类型,支持JSON与XML,默认为XML。
VersionStringAPI版本号,为日期形式:YYYY-MM-DD,本版本对应为2017-07-11。
AccessKeyIdString阿里云颁发给用户的访问服务所用的密钥ID,或者从您的业务服务器获取到的临时访问凭证中的临时密钥ID。
SignatureString签名结果串,关于签名的计算方法,请参见签名机制。
SignatureMethodString签名方式,目前支持HMAC-SHA1。
TimestampString请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ例如,2014-7-29T12:00:00Z(为北京时间2014年7月29日的20点0分0秒。
SignatureVersionString签名算法版本,目前版本是1.0。
SignatureNonceString唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。
SecurityTokenString是(特定情况)STS凭证,如果客户端从业务服务器获取STS凭证后访问智能云相册服务,该参数为必选。
LibraryIdString是(特定情况)照片库的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>



公共返回参数


用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码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", /* 返回结果数据 */
    }


注意:文档中的返回示例为了便于阅读,做了格式化处理,实际返回结果是没有进行换行、缩进等处理。

展开
收起
云栖大讲堂 2017-10-27 09:49:21 1702 分享 版权
阿里云 AI 助理回答

在阿里云的API调用中,公共请求参数是构成每一个API请求不可或缺的部分,它们确保了请求的安全性、版本控制以及格式规范等。您已经列举了一部分关键的公共请求参数及其说明,这里我将为您提供一个更清晰的总结和示例:

公共请求参数概览

  1. Format:

    • 类型: String
    • 是否必填: 否
    • 描述: 指定返回值的格式,支持JSONXML,默认为XML
  2. Version:

    • 类型: String
    • 是否必填: 是
    • 描述: API的版本号,格式为YYYY-MM-DD,例如2017-07-11
  3. AccessKeyId:

    • 类型: String
    • 是否必填: 是
    • 描述: 阿里云颁发给用户的访问服务密钥ID,或临时访问凭证中的临时密钥ID。
  4. Signature:

    • 类型: String
    • 是否必填: 是
    • 描述: 签名结果字符串,用于验证请求的完整性和来源,计算方法遵循阿里云的签名机制。
  5. SignatureMethod:

    • 类型: String
    • 是否必填: 是
    • 描述: 签名算法,目前只支持HMAC-SHA1
  6. Timestamp:

    • 类型: String
    • 是否必填: 是
    • 描述: 请求的时间戳,遵循ISO8601标准,使用UTC时间,如2014-7-29T12:00:00Z
  7. SignatureVersion:

    • 类型: String
    • 是否必填: 是
    • 描述: 签名算法版本,当前版本为1.0
  8. SignatureNonce:

    • 类型: String
    • 是否必填: 是
    • 描述: 用于防止重放攻击的随机字符串,每次请求应不同。
  9. SecurityToken (特定情况):

    • 类型: String
    • 是否必填: 视情况而定(使用STS认证时)
    • 描述: STS凭证,当客户端通过STS方式获取权限时需要提供。
  10. LibraryId (特定情况):

    • 类型: String
    • 是否必填: 视情况而定
    • 描述: 照片库的ID,根据认证方式(AK或STS)决定是否必须。

示例请求URL

基于上述参数,一个典型的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需要按照阿里云提供的签名算法进行计算,确保所有参数(包括非空的公共请求参数和业务参数)按规则排序并参与签名过程。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答