密钥管理API的公共请求参数和返回参数 - 密钥管理服务

公共参数分为公共请求参数和公共返回参数。

公共请求参数

名称	类型	是否必须	描述
Format	String	否	返回消息的格式。取值： JSON（默认值） XML
Version	String	是	API版本号，使用YYYY-MM-DD日期格式。取值：2016-01-20。
AccessKeyId	String	是	访问密钥ID。
Signature	String	是	消息签名。
SignatureMethod	String	是	签名方式。取值：HMAC-SHA1。
Timestamp	String	是	请求的时间戳，为日期格式。使用UTC时间并按照ISO8601标准，格式为：YYYY-MM-DDThh:mm:ssZ。例如：北京时间2022年01月10日20点00分00秒，表示为2022-01-10T12:00:00Z。
SignatureVersion	String	是	签名算法版本。取值：1.0。

公共请求参数示例如下：

https://kms.cn-hangzhou.aliyuncs.com/?Action=CreateKey
&Format=json
&Version=2016-01-20
&AccessKeyId=te****
&Signature=YlrFhyqDZQ1ThNYARrv3Ptaxqf****
&SignatureMethod=HMAC-SHA1
&Timestamp=2022-01-10T12:00:00Z
&SignatureVersion=1.0

公共返回参数

API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为JSON格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码RequestId。

返回2xx HTTP状态码表示调用成功。
返回4xx或5xx HTTP状态码表示调用失败。

公共返回参数示例如下：

XML格式

<?xml version="1.0" encoding="utf-8"?> 
    <!--结果的根结点-->
    <KMS>
        <!--返回请求标签-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--返回结果数据-->
    </KMS>

JSON格式

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216"
    /*返回结果数据*/
}