密鑰管理API的公用請求參數和返回參數 - Key Management Service

公用參數分為公用請求參數和公用返回參數。

公用請求參數

名稱	類型	是否必須	描述
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"
    /*返回結果資料*/
}