すべてのプロダクト
Search

このプロダクト

    :CreateInstance

    ドキュメントセンター

    :CreateInstance

    最終更新日:Mar 10, 2026

    ApsaraMQ for RocketMQ 5.x インスタンスを作成します。

    操作説明

    重要 Alibaba Cloud OpenAPI は管理 API です。これを使用して、Alibaba Cloud サービスのリソースを管理および照会できます。この API は管理システムにのみ統合してください。メッセージを送受信するコアデータリンクには使用しないでください。この方法では、データリンクにセキュリティリスクが生じます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:CreateInstance

    create

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:Instance/*

    		 なし なし

    リクエスト構文

    POST /instances HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    clientToken

    string

    任意

    リクエストのべき等性を保証するクライアント生成トークンです。トークンはリクエスト間で一意である必要があります。最大 64 ASCII 文字の長さです。

    c2c5d1274a8d4317a13bc5b0d4******
    body

    object

    任意

    リクエストボディです。

    instanceName

    string

    任意

    作成するインスタンスの名前です。

    このパラメーターを指定しない場合、インスタンス ID がインスタンス名として使用されます。

    rmq-cn-72u3048uxxx
    serviceCode

    string

    必須

    インスタンスのサービスコードです。ApsaraMQ for RocketMQ の場合、サービスコードは rmq です。

    rmq
    seriesCode

    string

    必須

    インスタンスのプライマリシリーズコードです。プライマリシリーズ間の違いについては、「製品選択」をご参照ください。

    有効値:

    • standard: Standard Edition

    • ultimate: Platinum Edition

    • professional: Professional Edition

    • dedicated: Exclusive Edition

    • shared: Shared Edition

    重要 インスタンス作成後、プライマリシリーズはスペックアップのみ可能です。スペックダウンはできません。スペックアップパスは、Standard Edition → Professional Edition → Platinum Edition です。例えば、Standard Edition から Professional Edition にスペックアップできますが、Professional Edition から Standard Edition にはスペックダウンできません。

    列挙値:

    • standard :

      Standard Edition

    • ultimate :

      Platinum Edition

    • professional :

      Professional Edition

    standard
    subSeriesCode

    string

    必須

    インスタンスのサブシリーズコードです。サブシリーズ間の違いについては、「製品選択」をご参照ください。

    有効値:

    • cluster_ha: 高可用性クラスターエディション

    • single_node: シングルノードテストエディション

    • serverless: サーバーレスインスタンス

    プライマリシリーズを ultimate (Platinum Edition) に設定した場合、サブシリーズは cluster_ha (高可用性クラスターエディション) にのみ設定できます。

    重要 インスタンス作成後、サブシリーズを変更することはできません。

    列挙値:

    • serverless :

      サーバーレスエディション

    • cluster_ha :

      高可用性クラスターエディション

    • single_node :

      シングルノードテストエディション

    cluster_ha
    paymentType

    string

    必須

    インスタンスの課金方法です。ApsaraMQ for RocketMQ はサブスクリプションと従量課金をサポートしています。

    有効値:

    • PayAsYouGo: 従量課金。これは使用後に支払う後払いモデルです。

    • Subscription: サブスクリプション。これは使用前に支払う前払いモデルです。

    詳細については、「課金方法」をご参照ください。

    列挙値:

    • PayAsYouGo :

      従量課金

    • Subscription :

      サブスクリプション

    Subscription
    period

    integer

    任意

    サブスクリプション期間です。このパラメーターは、paymentType が Subscription に設定されている場合にのみ有効です。

    有効値:

    • 月払い: 1、2、3、4、5、または 6

    • 年払い: 1、2、または 3

    3
    periodUnit

    string

    任意

    サブスクリプション期間の単位です。

    有効値:

    • Month: 月単位で購入します。

    • Year: 年単位で購入します。

    列挙値:

    • Month :

      月単位で購入します。

    • Year :

      年単位で購入します。

    Month
    autoRenew

    boolean

    任意

    自動更新を有効にするかどうかを指定します。このパラメーターは、paymentType が Subscription に設定されている場合にのみ有効です。

    • true: 自動更新を有効にします。

    • false: 自動更新を無効にします。

    列挙値:

    • true :

      自動更新を有効にします。

    • false :

      自動更新を無効にします。

    true
    autoRenewPeriod

    integer

    任意

    自動更新期間です。このパラメーターは、自動更新が有効になっている場合にのみ有効です。単位: ヶ月。

    有効値:

    • 月次更新: 1、2、3、6、または 12

    3
    remark

    string

    任意

    インスタンスに関する備考です。

    This is the remark for test.
    productInfo

    object

    任意

    インスタンスの仕様です。

    msgProcessSpec

    string

    任意

    メッセージの送受信に関するコンピューティング仕様です。最大 TPS 制限については、「インスタンスタイプ」をご参照ください。

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    任意

    インスタンスのメッセージ送信 TPS と合計 TPS の比率です。

    例えば、インスタンスの最大 TPS が 1,000 で比率が 0.8 の場合、メッセージ送信の最大 TPS は 800、メッセージ受信の最大 TPS は 200 です。

    値は [0.05、0.95] の範囲である必要があります。デフォルト: 0.5。

    0.5
    autoScaling

    boolean

    任意

    弾力的な TPS を有効にするかどうかを指定します。

    有効値:

    • true: 弾力的な TPS を有効にします。

    • false: 弾力的な TPS を無効にします。

    弾力的な TPS を有効にすると、ApsaraMQ for RocketMQ は、インスタンスが基本仕様の TPS 制限を特定の範囲内で超えることを許可します。追加の TPS に対して課金されます。課金の詳細については、「コンピューティング料金」をご参照ください。

    説明

    弾力的な TPS は特定のインスタンスタイプでのみサポートされています。詳細については、「インスタンスタイプ」をご参照ください。

    列挙値:

    • true :

      弾力的な TPS を有効にします。

    • false :

      弾力的な TPS を無効にします。

    true
    messageRetentionTime

    integer

    任意

    メッセージ保持期間です。単位: 時間。

    有効値については、「使用制限」の「リソースクォータ」セクションにあるメッセージ保持期間の制限をご参照ください。

    ApsaraMQ for RocketMQ は、サーバーレスで弾力的なメッセージストレージを提供します。実際に使用されたストレージに対して課金されます。ストレージ容量を制御するには、メッセージ保持期間を変更します。詳細については、「ストレージ料金」をご参照ください。

    72
    storageEncryption

    boolean

    任意

    ストレージ暗号化を有効にするかどうかを指定します。

    false
    storageSecretKey

    string

    任意

    ストレージ暗号化キーです。

    xxxxx
    capacityType

    string

    任意

    容量モードです。有効値: provisioned (予約済みおよび弾力的な) と ondemand (従量課金)。

    provisioned
    provisionedCapacity

    integer

    任意

    予約容量です。

    5000
    traceOn

    boolean

    任意

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

    有効値: true および false。 このパラメーターはサーバーレスインスタンスにのみ有効です。メッセージトレースを有効にすると、トレースに対して課金されます。課金の詳細については、「サーバーレス課金」をご参照ください。このパラメーターは従量課金またはサブスクリプションインスタンスには有効ではありません。これらのインスタンスでは、メッセージトレースはデフォルトで有効になっています。

    true
    networkInfo

    object

    必須

    ネットワーク構成です。

    vpcInfo

    object

    必須

    VPC 構成。

    vpcId

    string

    必須

    インスタンスが接続する VPC の ID です。

    説明

    ApsaraMQ for RocketMQ インスタンス作成後、VPC を変更することはできません。VPC を変更するには、インスタンスをリリースして新しいインスタンスを購入してください。

    vpc-wz9qt50xhtj9krb******
    vSwitchId deprecated

    string

    任意

    インスタンスが接続する vSwitch の ID です。複数の vSwitch がある場合は、ID を縦棒 (|) で区切ります。

    説明

    ApsaraMQ for RocketMQ インスタンス作成後、vSwitch を変更することはできません。vSwitch を変更するには、インスタンスをリリースして新しいインスタンスを購入してください。

    重要 このパラメーターは非推奨です。代わりに vSwitches パラメーターを使用してください。

    vsw-uf6gwtbn6etadpv*******
    securityGroupIds

    string

    任意

    セキュリティグループ ID です。

    sg-bp17hpmgz96tvnsdy6so
    vSwitches

    array<object>

    任意

    vSwitch のリストです。

    説明

    ApsaraMQ for RocketMQ インスタンス作成後、vSwitch を変更することはできません。vSwitch を変更するには、インスタンスをリリースして新しいインスタンスを購入してください。

    重要 これは必須パラメーターです。vSwitchId は非推奨であるため、このパラメーターを使用して vSwitch を構成してください。

    object

    任意

    vSwitchId

    string

    任意

    インスタンスが接続する vSwitch の ID です。

    vsw-uf6gwtbn6etadpv*******
    internetInfo

    object

    必須

    インターネット構成。

    internetSpec

    string

    必須

    インターネットアクセスを有効にするかどうかを指定します。

    有効値:

    • enable: インターネットアクセスを有効にします。

    • disable: インターネットアクセスを無効にします。

    デフォルトでは、インスタンスは VPC 経由で接続します。インターネットアクセスを有効にすると、ダウンストリームインターネット帯域幅に対して課金されます。課金の詳細については、「インターネットアクセス料金」をご参照ください。

    列挙値:

    • enable :

      インターネットアクセスを有効にします。

    • disable :

      インターネットアクセスを無効にします。

    disable
    flowOutType

    string

    必須

    インターネットアクセスに対する課金方法です。

    有効値:

    • payByBandwidth: 帯域幅課金。インターネットアクセスを有効にするには、この値を設定します。

    • payByTraffic: トラフィック課金。インターネットアクセスを有効にするには、この値を設定します。

    • uninvolved: 該当なし。インターネットアクセスを無効にするには、この値を設定します。

    列挙値:

    • payByBandwidth :

      帯域幅課金

    • payByTraffic :

      トラフィック課金

    • uninvolved :

      該当なし

    uninvolved
    flowOutBandwidth

    integer

    任意

    インターネット帯域幅の仕様です。単位: Mbit/s。

    このパラメーターは、インターネットアクセスに対する課金方法が帯域幅課金の場合にのみ必須です。

    有効値の範囲: 1～1000。

    100
    ipWhitelist deprecated

    array

    任意

    パブリックアクセスホワイトリストです。IP アドレスホワイトリストはインターネットエンドポイントにのみ構成できます。VPC エンドポイントはサポートされていません。

    • IP アドレスホワイトリストを構成しない場合、すべての IP アドレスがインターネット経由で ApsaraMQ for RocketMQ サービスにアクセスできます。

    • IP アドレスホワイトリストを構成した場合、ホワイトリスト内の IP アドレスのみがインターネット経由で ApsaraMQ for RocketMQ サービスにアクセスできます。

    string

    任意

    パブリックアクセスホワイトリスト内の IP アドレス範囲です。

    192.168.x.x/24
    commodityCode

    string

    任意

    商品コードです。

    • ons_rmqpost_public_intl: 従量課金

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

    • ons_rmqsrvlesspost_public_intl: サーバーレスインスタンス このパラメーターはサーバーレスインスタンスに必須です。

    ons_ rmqpost_public_cn
    resourceGroupId

    string

    任意

    リソースグループ ID です。

    rg-aekzy6pist7uuna
    tags

    array<object>

    任意

    リソースタグのリストです。

    object

    任意

    リソースタグ。

    key

    string

    任意

    リソースタグのキーです。

    xxxKey
    value

    string

    任意

    リソースタグの値です。

    xxxValue
    aclInfo

    object

    任意

    アクセス制御情報です。

    defaultVpcAuthFree

    boolean

    任意

    インテリジェントな ID 認識のために、VPC 経由のパスワードレスアクセスを有効にするかどうかを指定します。

    • true: パスワードレスアクセスを有効にします。

    • false: パスワードレスアクセスを無効にします。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータです。

    requestId

    string

    リクエスト ID です。各リクエスト ID は一意です。問題のトラブルシューティングにご利用ください。

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

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

    true
    data

    string

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

    rmq-cn-7e22ody****
    code

    string

    エラーコードです。

    200
    message

    string

    エラーメッセージです。

    Success
    httpStatusCode

    integer

    HTTP ステータスコードです。

    200
    dynamicCode

    string

    動的エラーコードです。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージです。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": "rmq-cn-7e22ody****",
  "code": "200",
  "message": "Success",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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