すべてのプロダクト
Search

このプロダクト

    :CreateInstance

    ドキュメントセンター

    :CreateInstance

    最終更新日:Feb 04, 2026

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

    操作説明

    重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスのリソースを管理および照会するための管理 API です。管理目的でのみ OpenAPI を統合してください。メッセージの送受信を行うコアのデータリンクには OpenAPI を依存させないでください。これにより、データリンクにリスクが生じる可能性があります。

    今すぐお試しください

    この 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：High-availability Cluster Edition

    • single_node：Single-node Testing Edition

    • serverless：Serverless instance

    プライマリシリーズをアルティメット (Platinum Edition) に設定する場合、サブシリーズを cluster_ha (高可用性クラスターエディション) に設定する必要があります。

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

    列挙値:

    • serverless :

      Serverless Edition

    • cluster_ha :

      High-availability Cluster Edition

    • single_node :

      Single-node Testing Edition

    cluster_ha
    paymentType

    string

    必須

    インスタンスの課金方法です。ApsaraMQ for RocketMQ では、従量課金およびサブスクリプションがサポートされています。

    有効な値：

    • PayAsYouGo：従量課金。使用したリソースに対して後払いされる課金モードです。

    • Subscription：サブスクリプション。リソースを使用する前に前払いする課金モードです。

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

    列挙値:

    • PayAsYouGo :

      pay-as-you-go

    • Subscription :

      subscription

    Subscription
    period

    integer

    任意

    サブスクリプション期間です。このパラメーターは、paymentType を Subscription に設定した場合にのみ有効です。

    有効な値：

    • 月単位で購入する場合：1、2、3、4、5、6

    • 年単位で購入する場合：1、2、3

    3
    periodUnit

    string

    任意

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

    有効な値：

    • Month：月単位で購入

    • Year：年単位で購入

    列挙値:

    • Month :

      purchase by month

    • Year :

      purchase by year

    Month
    autoRenew

    boolean

    任意

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

    • true：自動更新を有効にする

    • false：自動更新を無効にする

    列挙値:

    • true :

      enables auto-renewal

    • false :

      disables auto-renewal

    true
    autoRenewPeriod

    integer

    任意

    自動更新サイクルです。このパラメーターは、autoRenew を true に設定した場合にのみ有効です。単位：月。

    有効な値：

    • 月単位で更新する場合：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

    任意

    仕様を超えたバーストスケーリングを有効にするかどうかを指定します。

    有効な値:

    • true: バーストスケーリングを有効にします

    • false: バーストスケーリングを無効にします

    バーストスケーリングを有効にすると、インスタンスのベース TPS を超えることができます。追加の TPS に対して課金されます。課金の詳細については、「コンピューティング料金」をご参照ください。

    説明

    一部のインスタンスタイプのみがバーストスケーリングをサポートしています。サポートされているインスタンスタイプの詳細については、「インスタンスタイプ」をご参照ください。

    列挙値:

    • true :

      バーストスケーリングを有効にします

    • false :

      バーストスケーリングを無効にします

    true
    messageRetentionTime

    integer

    任意

    メッセージ保持期間。単位：時間。

    有効な値については、「Limits」の「Resource Quotas」トピックにある「Message Retention Period」セクションをご参照ください。

    ApsaraMQ for RocketMQ のメッセージストレージはサーバーレスで弾力的なため、ご利用のストレージ量に応じて課金されます。メッセージ保持期間を変更することで、ストレージ容量を制御できます。詳細については、「Storage fees」をご参照ください。

    72
    storageEncryption

    boolean

    任意

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

    false
    storageSecretKey

    string

    任意

    ストレージ暗号化に使用するキーです。

    xxxxx
    capacityType

    string

    任意

    容量モードです。`provisioned`：予約型およびエラスティック型、`onDemand`：従量課金型。

    provisioned
    provisionedCapacity

    integer

    任意

    予約済みキャパシティです。

    5000
    traceOn

    boolean

    任意

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

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

    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 :

      enables public network access

    • disable :

      disables public network access

    disable
    flowOutType

    string

    必須

    パブリックネットワークアクセスの課金方法です。

    有効な値：

    • payByBandwidth：帯域幅課金。パブリックネットワークアクセスを有効にする場合にこの値を指定します。

    • payByTraffic：トラフィック課金。パブリックネットワークアクセスを有効にする場合にこの値を指定します。

    • uninvolved：該当なし。パブリックネットワークアクセスを無効にする場合にこの値を指定します。

    列挙値:

    • payByBandwidth :

      pay-by-bandwidth

    • payByTraffic :

      pay-by-data-transfer

    • uninvolved :

      not involved

    uninvolved
    flowOutBandwidth

    integer

    任意

    パブリック帯域幅です。単位：Mbit/s。

    このパラメーターは、flowOutType を payByBandwidth に設定した場合にのみ必須です。

    有効な値：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：Serverless インスタンス このパラメーターは Serverless インスタンスに必須です。

    ons_ rmqpost_public_cn
    resourceGroupId

    string

    任意

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

    rg-aekzy6pist7uuna
    tags

    array<object>

    任意

    リソースに付与するタグのリストです。

    object

    任意

    リソースに割り当て可能なタグです。

    key

    string

    任意

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

    xxxKey
    value

    string

    任意

    リソースタグの値です。

    xxxValue
    aclInfo

    object

    任意

    アクセス制御情報です。

    defaultVpcAuthFree

    boolean

    任意

    VPC 経由のインテリジェント ID 認証におけるパスワード不要アクセスを有効化するかどうかを指定します。

    • 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"
}

    エラーコード

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

    変更履歴

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