すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RabbitMQ:CreateInstance

    ドキュメントセンター

    ApsaraMQ for RabbitMQ:CreateInstance

    最終更新日:Jun 25, 2026

    ApsaraMQ for RabbitMQ インスタンスを作成します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    amqp:CreateInstance

    create

    *All Resource

    *
    • amqp:InstanceType
    • amqp:SupportEIP
    • amqp:ServerlessChargeType
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClientToken

    string

    任意

    クライアントトークン。

    c2c5d1274axxxxxxxx
    PaymentType

    string

    必須

    支払いタイプ。有効な値:

    • Subscription: サブスクリプション

    • PayAsYouGo: サーバーレス。

    列挙値:

    • PayAsYouGo :

      PayAsYouGo。

    • Subscription :

      Subscription。

    Subscription
    Period

    integer

    任意

    サブスクリプション期間。単位: periodCycle。

    説明

    このパラメーターは、PaymentType が Subscription に設定されている場合にのみ有効です。デフォルト値: 1。

    1
    PeriodCycle

    string

    任意

    サブスクリプション期間の単位。有効な値:

    • Month: 月

    • Year: 年

    このパラメーターは、PaymentType が Subscription に設定されている場合にのみ有効です。デフォルト値: Month。

    列挙値:

    • Month :

      Month。

    • Year :

      Year。

    Month
    AutoRenew

    boolean

    任意

    更新方法。有効な値:

    • true: 自動更新が有効です。

    • false: 手動更新が必要です。

    false
    AutoRenewPeriod

    integer

    任意

    自動更新エポック。単位: RenewalDurationUnit の値。デフォルト単位: 月。

    説明

    このパラメーターは、AutoRenew が true に設定されている場合にのみ有効です。デフォルト値: 1。

    1
    RenewStatus

    string

    任意

    更新ステータス。このパラメーターは autoRenew と同等です。2 つのパラメーターのうち 1 つのみを指定してください。有効な値:

    • AutoRenewal: 自動更新が有効です。

    説明

    autoRenew と renewStatus はどちらも更新方法を指定します。両方が指定された場合、renewStatus が優先されます。

    false
    RenewalDurationUnit

    string

    任意

    自動更新エポックの単位。有効な値:

    • Month: 月

    • Year: 年。

    列挙値:

    • Month :

      Month。

    • Year :

      Year。

    Month
    InstanceType

    string

    任意

    インスタンスタイプ。 サブスクリプションインスタンスの有効な値:

    • professional: Professional Edition

    • enterprise: Enterprise Edition

    • vip: プラチナエディション

    サーバーレスインスタンスの場合、このパラメーターを指定する必要はありません。

    列挙値:

    • enterprise :

      enterprise。

    • vip :

      vip。

    • professional :

      professional。

    professional
    ServerlessChargeType

    string

    任意

    サーバーレスインスタンスの課金タイプ。有効な値:

    • onDemand: 従量課金。

    onDemand
    InstanceName

    string

    任意

    インスタンス名。名前は 64 文字以内にすることをお勧めします。

    amqp-xxxxx
    MaxPrivateTps

    integer

    任意

    プライベートネットワーク TPS トラフィック。単位: 1 秒あたりのトランザクション数。

    ApsaraMQ for RabbitMQ 購入ページに記載されている値に基づいて設定してください。

    1000
    SupportEip

    boolean

    任意

    パブリックネットワークアクセスをサポートするかどうかを指定します。有効な値:

    • true: パブリックネットワークアクセスがサポートされます。

    • false: パブリックネットワークアクセスはサポートされません。

    true
    MaxEipTps

    integer

    任意

    ピークパブリックネットワーク TPS トラフィック。単位: TPS。

    ApsaraMQ for RabbitMQ 購入ページに記載されている値に基づいて設定してください。

    128
    QueueCapacity

    integer

    任意

    キューの数。

    ApsaraMQ for RabbitMQ 購入ページに記載されている値に基づいて設定してください。

    1000
    MaxConnections

    integer

    任意

    接続数の最大値。

    ApsaraMQ for RabbitMQ 購入ページに記載されている値に基づいて設定してください。

    50000
    StorageSize

    integer

    任意

    メッセージストレージスペース。単位: GB。有効な値:

    • Professional Edition およびエンタープライズインスタンス: 0 に固定。

    説明

    値 0 は、Professional Edition およびエンタープライズインスタンスではストレージ料金が発生しないことを示しており、ストレージスペースがないことを意味するものではありません。

    • プラチナエディションインスタンス: m × 100、m の範囲は [7,28]。

    7
    SupportTracing

    boolean

    任意

    メッセージトレース機能を有効にするかどうかを指定します。有効な値:

    • true: メッセージトレース機能が有効です。

    • false: メッセージトレース機能が無効です。

    説明

    • プラチナエディションインスタンスでは、メッセージトレース機能が 15 日間無料で提供されます。トレース機能は有効化のみ可能で、トレース保持期間は 15 日間のみ設定できます。

    • その他のタイプのインスタンスでは、トレース機能を有効または無効にできます。

    true
    TracingStorageTime

    integer

    任意

    メッセージトレースの保持期間。単位: 日。有効な値:

    • 3: 3 日

    • 7: 7 日

    • 15: 15 日

    このパラメーターは、SupportTracing が true に設定されている場合にのみ有効です。

    3
    ResourceGroupId

    string

    任意

    インスタンスが属するリソースグループの ID。

    rg-acfmvvajg5qkxhi
    EncryptedInstance

    boolean

    任意

    この機能は専用インスタンス限定です。インスタンスのデータストレージ暗号化を有効にするかどうかを指定します。

    false
    KmsKeyId

    string

    任意

    この機能は専用インスタンス限定です。EncryptedInstance が true に設定されている場合、このパラメーターは必須です。保存データの暗号化に使用される KMS キーの ID。キーは次の要件を満たす必要があります:

    • キーはサービスキーであってはなりません。

    • キーはアクティブな状態である必要があります。

    • キーは対称キーである必要があり、非対称キーは使用できません。

    • キーの用途は暗号化と復号である必要があります。

    • KMS キーが期限切れになるか削除されると、データの読み取りと書き込みが利用できなくなり、RabbitMQ インスタンス障害が発生します。

    key-xxx
    ProvisionedCapacity

    integer

    任意

    プロビジョニング + エラスティックインスタンスのプロビジョニング済み TPS 容量。

    2000
    Edition

    string

    任意

    サーバーレスインスタンスの Deployment アーキテクチャ。有効な値:

    • shared: 共有アーキテクチャ。プロビジョニング + エラスティック (共有) および従量課金エディションに適用されます。

    • dedicated: 専用アーキテクチャ。プロビジョニング + エラスティック (専用) エディションに適用されます。

    shared
    Tags

    array<object>

    任意

    リソースタグ。

    object

    任意

    タグオブジェクト。

    Key

    string

    任意

    タグキー。

    testKey
    Value

    string

    任意

    タグ値。

    testValue
    VpcId

    string

    必須

    PrivateLink エンドポイントの作成に使用する VPC ID。

    vpc-xxx
    VswitchIds

    array

    必須

    インスタンス作成時に PrivateLink エンドポイントの作成に使用する vSwitch ID。

    1. 2 つの vSwitch ID が必須で、異なるゾーンに属している必要があります (シングルゾーンのリージョンを除く)。

    2. vSwitch は指定された VPC に属している必要があります。

    3. vSwitch のステータスは Available である必要があります。

    4. 各 vSwitch には少なくとも 20 個の利用可能な IP アドレスが必要です。

    5. 各 vSwitch のゾーンは NLB の作成をサポートしている必要があります。

    string

    必須

    インスタンス作成時に指定する vSwitch ID。

    vsw-xxx
    SecurityGroupId

    string

    必須

    PrivateLink エンドポイントの作成に使用するセキュリティグループ。

    1. プロトコルタイプ TCP で送信先ポート 5672 および 5671 を許可するインバウンドアクセスポリシーを追加してください。

    2. マネージドセキュリティグループはサポートされません。

    3. セキュリティグループは指定された VPC に属している必要があります。

    sg-xxx
    ListenerMode

    string

    任意

    インスタンスが TLS 暗号化ポートのみを有効にするかどうかを指定します。このパラメーターは専用プロビジョニング + エラスティックインスタンスおよびプラチナエディションインスタンスでのみサポートされます。

    tcp_and_ssl
    AuthModel

    string

    任意

    ram openSource
    ServerlessSwitch

    boolean

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    JsonResult。

    RequestId

    string

    共通パラメーター。各リクエストには、トラブルシューティングに使用できる一意の ID があります。

    CCBB1225-C392-480E-8C7F-D09AB2CD2***
    Code

    integer

    応答コード。値 200 は成功を示します。

    200
    Message

    string

    応答メッセージ。

    xxx failed,xxxx
    Data

    any

    作成されたインスタンスの ID。

    amqp-cn-xxxxx
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
  "Code": 200,
  "Message": "xxx failed,xxxx",
  "Data": "amqp-cn-xxxxx",
  "Success": true
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。