すべてのプロダクト
Search

このプロダクト

    :共通パラメーター

    ドキュメントセンター

    :共通パラメーター

    最終更新日:Jul 09, 2024

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

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

    Apache RocketMQ APIリクエストのすべてのMessage Queueに共通のリクエストパラメーターを含める必要があります。

    パラメーター

    データ型

    必須

    説明

    Format

    String

    任意

    レスポンスを返す形式を設定します。 有効な値 : JSON と XML。 デフォルト値：XML。

    productName

    String

    必須

    APIの名前。 [オン] を入力します。

    Domain

    String

    必須

    APIエンドポイントのドメイン。 値の形式はons.${RegionI d}.aliyuncs.comです。 domainパラメーターで指定されたリージョンは、regionIdパラメーターで指定されたリージョンと一致している必要があります。

    Version

    String

    必須

    API のバージョン番号です。 値はYYYY-MM-DDの形式でなければなりません。 値の例: 2019-02-14。

    AccessKeyId

    String

    必須

    Alibaba Cloudから提供されたAccessKeyペア。

    • Alibaba CloudアカウントまたはRAMユーザーを使用してAPI操作を呼び出す場合、これらのパラメーターはAlibaba CloudアカウントまたはRAMユーザーのAccessKey IDおよびAccessKey secretです。

    • RAMユーザーを使用してAPI操作を呼び出す場合、これらのパラメーターは、取得したSecurity Token Service (STS) トークンのAccessKey IDとAccessKey secretです。 詳細については、「RAMユーザーへの権限付与」をご参照ください。

    AccessKeySecret

    String

    必須

    Signature

    String

    必須

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

    SignatureMethod

    String

    必須

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

    Timestamp

    String

    必須

    リクエストのタイムスタンプです。 時刻を ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ) の形式で指定します。 時刻は UTC である必要があります。 たとえば、2013年1月10日の20:00:00 (UTC + 8) は、2013-01-10T12:00:00Zと記述されます。

    SignatureVersion

    String

    必須

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

    SignatureNonce

    String

    必須

    リプレイ攻撃を防ぐための、一意の乱数を設定します。 各リクエストで異なる乱数を使用する必要があります。

    リクエストの例

    https:/ons.cn-hangzhou.aliyuncs.com/? Action=OnsRegionList
&Format=JSON
&Version=2019-02-14
&AccessKeyId=key-test
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&Timestamp=2020-01-01T12:00:00Z
&SignatureNonce=1521552885****
&SignatureVersion=1.0
...

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

    すべての応答は、呼び出しが成功したかどうかに関係なく、一意のRequestIDを返します。 応答は、統一された形式で返すことができる。 APIレスポンスはHTTPレスポンス形式を使用します。2xxステータスコードは正常な呼び出しを示し、4xxまたは5xxステータスコードは失敗した呼び出しを示します。

    XML 形式

    <? xml version="1.0" encoding="UTF-8"? >
<!--Result Root Node-->
<Interface Name+Response>
 | <!--Return Request Tag-->
 | <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
 | <!--Return Result Data-->
</Interface Name+Response>

    JSON 形式

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