すべてのプロダクト
Search
ドキュメントセンター

:共通パラメーター

最終更新日:Dec 18, 2024

このトピックでは、すべてのAPIリクエストとレスポンスに共通するパラメーターについて説明します。

共通リクエストパラメーター

パラメーター

必須 / 任意

説明

Format

String

任意

応答形式。 有効な値:

  • JSON (デフォルト)

  • XML

Version

String

対象

API のバージョン番号です。 値はYYYY-MM-DD形式でなければなりません。 値を2016-01-20に設定します。

AccessKeyId

String

対象

Alibaba Cloud から提供された AccessKey ID です。

Signature

String

対象

現在のリクエストの署名文字列。

SignatureMethod

String

対象

署名文字列の暗号化方式を設定します。 値を HMAC-SHA1 に設定します。

Timestamp

String

対象

リクエストのタイムスタンプです。 時刻を ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ) の形式で指定します。 時刻は UTC である必要があります。

たとえば、2022-01-10T12:00:00Zを使用して、1月10日2022 20:00:00 (UTC + 8) を示します。

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          

共通レスポンスパラメーター

レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエストでレスポンスの形式を指定できます。 デフォルトの応答形式はJSONです。 呼び出しの成否に関わらず、すべてのレスポンスで一意の RequestId が返されます。

  • HTTP 2xxステータスコードは、呼び出しが成功したことを示します。

  • HTTP 4xxまたは5xxステータスコードは、失敗した呼び出しを示します。

レスポンスの例

  • XML 形式

    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <KMS>
            <!--Return Request Tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--Return Result Data-->
        </KMS>                        
  • JSON 形式

    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216"
        /*Return Result Data*/
    }