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

:共通パラメーター

最終更新日:Apr 22, 2025

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

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

パラメーター

タイプ

必須

説明

Format

String

いいえ

レスポンスを返す形式。デフォルト値:XML。有効な値:

  • JSON

  • XML (デフォルト)

Version

String

はい

API のバージョン番号。 YYYY-MM-DD 形式でバージョン番号を指定します。値を 2019-09-10 に設定します。

Signature

String

はい

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

SignatureMethod

String

はい

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

SignatureNonce

String

はい

リプレイ攻撃を防ぐために使用される一意の乱数。リクエストごとに異なる番号を使用する必要があります。

SignatureVersion

String

はい

署名暗号化アルゴリズムのバージョン。値を 1.0 に設定します。

AccessKeyId

String

はい

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

Timestamp

String

はい

リクエストのタイムスタンプ。ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式で時間を指定します。時間は UTC である必要があります。

たとえば、2013-01-10T12:00:00Z は、2013 年 1 月 10 日 20:00:00 (UTC + 08:00) を指定します。

リクエストの例

http(s)://ros.aliyuncs.com/?Action=CreateStack
&Format=xml
&Version=2019-09-10
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1521552885****
&SignatureVersion=1.0
&AccessKeyId=LTAI****************
&Timestamp=2020-06-01T12:00:00Z

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

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

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

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

レスポンスの例

  • XML 形式

    <?xml version="1.0" encoding="utf-8"?> 
        ><!--Result root node-->
        <Operation name + Response>
            <!--Response request tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--Returned data-->
        </Operation name + Response>                        
  • JSON 形式

    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216"
        /*Returned data*/
    }