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

ApsaraMQ for RabbitMQ:CreateInstance

最終更新日:Aug 04, 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

必須

課金タイプ。有効な値:

列挙値:

  • PayAsYouGo :

    PayAsYouGo。

  • Subscription :

    Subscription。

Subscription

Period

integer

任意

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

1

PeriodCycle

string

任意

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

列挙値:

  • Month :

    Month。

  • Year :

    Year。

Month

AutoRenew

boolean

任意

更新メソッド。有効な値:

false

AutoRenewPeriod

integer

任意

自動更新のエポック。単位は RenewalDurationUnit の値で指定されます。デフォルトの単位: 月。

1

RenewStatus

string

任意

更新ステータス。このパラメーターは autoRenew と同等です。どちらか一方のみを設定する必要があります。有効な値:

false

RenewalDurationUnit

string

任意

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

列挙値:

  • Month :

    Month。

  • Year :

    Year。

Month

InstanceType

string

任意

インスタンスタイプ。

列挙値:

  • enterprise :

    enterprise。

  • vip :

    vip。

  • professional :

    professional。

professional

ServerlessChargeType

string

任意

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

onDemand

InstanceName

string

任意

インスタンス名。名前の長さは最大 64 文字です。

amqp-xxxxx

MaxPrivateTps

integer

任意

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

1000

SupportEip

boolean

任意

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

true

MaxEipTps

integer

任意

ピーク時のパブリックネットワーク TPS。単位: TPS。

128

QueueCapacity

integer

任意

キューの数。単位: 個。

1000

MaxConnections

integer

任意

接続数の最大値。

50000

StorageSize

integer

任意

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

7

SupportTracing

boolean

任意

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

true

TracingStorageTime

integer

任意

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

3

ResourceGroupId

string

任意

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

rg-acfmvvajg5qkxhi

EncryptedInstance

boolean

任意

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

false

KmsKeyId

string

任意

この特徴は専用インスタンスでのみ利用可能です。EncryptedInstance が true にセットされている場合、このパラメーターは必須です。保存データのデータ暗号化に使用される KMS キーの ID。キーは以下の要件を満たす必要があります:

key-xxx

ProvisionedCapacity

integer

任意

予約済み + エラスティックインスタンスのプロビジョニング済み TPS キャパシティ。

2000

Edition

string

任意

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

shared

Tags

array<object>

任意

リソースタグ。

object

任意

タグオブジェクト。

Key

string

任意

リソースタグキー。

testKey

Value

string

任意

リソースタグ値。

testValue

VpcId

string

必須

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

vpc-xxx

VswitchIds

array

必須

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

string

必須

インスタンス作成時に指定された vSwitch の ID。

vsw-xxx

SecurityGroupId

string

必須

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

sg-xxx

ListenerMode

string

任意

インスタンスに対して TLS 暗号化ポートのみを有効にするかどうかを指定します。このパラメーターは、専用の予約済み + エラスティックおよびプラチナインスタンスでのみサポートされています。

tcp_and_ssl

AuthModel

string

任意

認証モード。デフォルト値: RAM 認証モード。

列挙値:

  • openSource :

    openSource。

  • ram :

    ram。

ram

ServerlessSwitch

boolean

任意

エラスティックスイッチ。

以下の例には必須パラメーターのみが含まれています。必要に応じて他のパラメーターを設定してください:

サーバーレス従量課金インスタンスを購入する場合:

サーバーレス予約済み + エラスティック (共有) インスタンスを購入する場合:

> provisionedCapacity の範囲は [2000, 20000] で、ステップサイズは 2000 です。

```json.

サーバーレス予約済み + エラスティック (専用) インスタンスを購入する場合:

> provisionedCapacity の範囲は [5000, 500000] で、ステップサイズは 5000 です。

```json.

Enterprise インスタンスを購入する場合:

> MaxPrivateTps の有効な値: 3000、5000、8000、10000、15000、20000、30000、40000、50000、80000、100000

```json.

プラチナインスタンスを購入する場合:

> MaxPrivateTps の有効な値: 8000、15000、25000、40000、50000、100000、200000、300000、500000、800000、1000000

```json.

レスポンスフィールド

フィールド

説明

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
}

エラーコード

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

変更履歴

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