全部产品

公共参数

您可以阅读本文,了解API公共参数的名称和描述。

公共请求参数

公共请求参数是指所有接口都需要使用的参数。

名称

类型

是否必选

描述

Version

String

API版本号,为日期形式:YYYY-MM-DD。

当前版本对应为2020-11-09。

AccessKeyId

String

阿里云颁发给用户的访问服务所用的密钥ID。

AccessKeySecret

String

用于加密签名字符串和ICE用来验证签名字符串的密钥。

Signature

String

签名结果串。关于签名的计算方法,详情请参见 签名机制

示例代码请参见:

签名机制

SignatureMethod

String

签名方式,目前支持HMAC-SHA1。

Timestamp

String

请求的时间戳。日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2020-3-29T12:00:00Z代表北京时间2020年3月29日的20点0分0秒。

示例代码参见:

签名机制

SignatureVersion

String

签名算法版本,目前版本是1.0。

SignatureNonce

String

唯一随机数。

在不同请求间使用不同的随机数值,防止网络重放攻击。

示例代码请参见:

签名机制

SecurityToken

String

STS临时授权的Token,默认为空。

概念请参见

账号权限

的STS临时AK部分,生成方式请参见:

创建角色并进行STS临时授权

示例

http://ice.cn-shanghai.aliyuncs.com/
    ?Format=json 
    &Version=2020-11-09
    &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D 
    &SignatureMethod=Hmac-SHA1
    &SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
    &SignatureVersion=1.0
    &Action=GetEditingProject
    &AccessKeyId=XXXXXXX  
    &Timestamp=2020-03-29T09%3A22%3A32Z

公共返回参数

每一个接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId。

XML示例

<?xml version="1.0" encoding="UTF-8"?>
    <!—结果的根结点--> 
    <接口名称+Response> <!—返回请求标签-->
        <RequestId>*****B38-3910-447D-87BC-AC0491*****</RequestId>
        <!—返回结果数据--> 
    </接口名称+Response>

JSON示例

{
    "RequestId": "*****B38-3910-447D-87BC-AC0491*****"
}