CreateInstance API 呼び出しによるインスタンス作成 - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

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

操作説明

重要

Alibaba Cloud の OpenAPI は、リソースを管理・照会するための管理 API です。管理プレーンとの統合のみを目的としています。不安定性を防ぐため、コアデータリンクにおけるメッセージトランスポートには 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 が名前として使用されます。このパラメータを空白のままにした場合、インスタンス ID がインスタンス名として使用されます。	rmq-cn-72u3048uxxx
serviceCode	string	必須	インスタンスのサービスコードです。Message Queue for Apache RocketMQ の場合、サービスコードは`rmq`です。	rmq
seriesCode	string	必須	インスタンスのプライマリエディションです。プライマリエディション間の違いの詳細については、「製品の選択」をご参照ください。重要インスタンスの作成後は、エディションのアップグレードのみ可能で、ダウングレードはできません。アップグレードパスは、Standard Edition > Professional Edition > Platinum Edition です。列挙値: standard : Standard Edition ultimate : Platinum Edition professional : Professional Edition	standard
subSeriesCode	string	必須	インスタンスのサブエディションです。サブエディション間の違いの詳細については、「製品の選択」をご参照ください。 `seriesCode` パラメータを `ultimate` (Platinum Edition) に設定した場合、このパラメータは `cluster_ha` (High-availability Cluster Edition) にのみ設定できます。重要インスタンスの作成後は、そのサブエディションを変更することはできません。列挙値: serverless : Serverless Edition cluster_ha : High-availability Cluster Edition single_node : Single-node Testing Edition	cluster_ha
paymentType	string	必須	インスタンスの課金方法です。Message Queue for Apache RocketMQ は、サブスクリプションと従量課金をサポートしています。詳細については、「課金方法」をご参照ください。列挙値: PayAsYouGo : 従量課金。実際の使用量に基づいて課金される後払い方式です。 Subscription : サブスクリプション。事前にサブスクリプション期間の料金を支払う前払い方式です。	Subscription
period	integer	任意	サブスクリプション期間です。このパラメータは、`paymentType` パラメータを `Subscription` に設定した場合にのみ必須です。有効な値： `periodUnit` が `Month` に設定されている場合、有効な値は 1、2、3、4、5、6 です。 `periodUnit` が `Year` に設定されている場合、有効な値は 1、2、3 です。	3
periodUnit	string	任意	サブスクリプション期間の単位です。列挙値: Month : サブスクリプション期間は月単位で指定されます。 Year : サブスクリプション期間は年単位で指定されます。	Month
autoRenew	boolean	任意	インスタンスの自動更新を有効にするかどうかを指定します。このパラメータは、サブスクリプションインスタンスに対してのみ有効です。列挙値: 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 を有効にするかどうかを指定します。この機能を有効にすると、インスタンスは基本仕様で指定された量よりも多くのメッセージを処理できます。追加の TPS は課金対象となります。詳細については、「コンピューティング料金」をご参照ください。説明この機能は、特定のインスタンスエディションでのみサポートされています。詳細については、「インスタンス仕様」をご参照ください。列挙値: true : エラスティック TPS を有効にします。 false : エラスティック TPS を無効にします。	true
messageRetentionTime	integer	任意	メッセージの保持期間です。単位は時間です。値の範囲については、「制限事項」トピックの「メッセージ保持期間」セクションをご参照ください。 Message Queue for Apache RocketMQ は、実際の使用量に基づいて課金されるサーバーレスメッセージストレージを提供します。メッセージ保持期間を調整して、ストレージ容量を管理できます。詳細については、「ストレージ料金」をご参照ください。	72
storageEncryption	boolean	任意	ストレージ暗号化を有効にするかどうかを指定します。	false
storageSecretKey	string	任意	ストレージ暗号化に使用されるキーです。	xxxxx
capacityType	string	任意	容量モードです。列挙値: provisioned : 予約済み + エラスティック ondemand : 従量課金	provisioned
provisionedCapacity	integer	任意	予約容量です。	5000
traceOn	boolean	任意	メッセージトレース機能を有効にするかどうかを指定します。このパラメータは、Serverless Edition のインスタンスに対してのみ有効です。メッセージトレース機能を有効にすると、その機能は課金対象となります。詳細については、「Serverless Edition の課金」をご参照ください。従量課金およびサブスクリプションインスタンスの場合、このパラメータは適用されません。これらのインスタンスでは、メッセージトレース機能はデフォルトで有効になっています。	true
drReplicationMode	string	任意	クロスゾーンレプリケーションモードです。列挙値: async_cross_az : 非同期レプリケーション sync_cross_az : 同期レプリケーション	async_cross_az
networkInfo	object	必須	ネットワーク設定です。
vpcInfo	object	必須	Virtual Private Cloud (VPC) の設定です。
vpcId	string	必須	インスタンスが接続されている VPC の ID です。説明 Message Queue for Apache RocketMQ インスタンスの作成後は、インスタンスが接続されている VPC を変更することはできません。VPC を変更したい場合は、インスタンスを解放して新しいインスタンスを購入する必要があります。	vpc-wz9qt50xhtj9krb******
vSwitchId `deprecated`	string	任意	インスタンスが接続されている vSwitch の ID です。インスタンスを複数の vSwitch に接続したい場合は、vSwitch ID を縦棒 (\|) で区切ります。説明 Message Queue for Apache RocketMQ インスタンスの作成後は、インスタンスが接続されている vSwitch を変更することはできません。vSwitch を変更したい場合は、インスタンスを解放して新しいインスタンスを購入する必要があります。重要このパラメータは非推奨です。`vSwitches` パラメータを使用することを推奨します。	vsw-uf6gwtbn6etadpv*******
securityGroupIds	string	任意	セキュリティグループの ID です。	sg-bp17hpmgz96tvnsdy6so
vSwitches	array<object>	任意	vSwitch のリストです。説明 Message Queue for Apache RocketMQ インスタンスの作成後は、インスタンスの vSwitch を変更することはできません。vSwitch を変更したい場合は、インスタンスを解放して新しいインスタンスを購入する必要があります。重要非推奨の `vSwitchId` パラメータの代わりに、このパラメータを使用して vSwitch を指定することを推奨します。
	object	任意	vSwitch です。
vSwitchId	string	任意	インスタンスが接続されている vSwitch の ID です。	vsw-uf6gwtbn6etadpv*******
internetInfo	object	必須	インターネットアクセス設定です。
internetSpec	string	必須	インターネットアクセスを有効にするかどうかを指定します。デフォルトでは、インスタンスは VPC 内からのみアクセスできます。インスタンスのインターネットアクセスを有効にすると、インスタンスによって生成されたインターネットトラフィックは課金対象となります。詳細については、「インターネットアクセス料金」をご参照ください。列挙値: enable : インターネットアクセスを有効にします。 disable : インターネットアクセスを無効にします。	disable
flowOutType	string	必須	インターネットアクセスの課金方法です。列挙値: payByBandwidth : 帯域幅課金。この課金方法は、インターネットアクセスを有効にした場合にのみ利用できます。 payByTraffic : トラフィック課金。この課金方法は、インターネットアクセスを有効にした場合にのみ利用できます。 uninvolved : 該当なし。この値は、インターネットアクセスを無効にした場合に使用されます。	uninvolved
flowOutBandwidth	integer	任意	インターネット帯域幅です。単位は Mbit/s です。このパラメータは、インターネットアクセスの課金方法が帯域幅課金の場合にのみ必須です。値の範囲：1～1000	100
ipWhitelist `deprecated`	array	任意	インターネットアクセス用の IP アドレスホワイトリストです。IP アドレスホワイトリストは、パブリックエンドポイントに対してのみ設定できます。VPC エンドポイントはこの機能をサポートしていません。 IP アドレスホワイトリストを設定しない場合、すべての IP アドレスがインターネット経由で Message Queue for Apache RocketMQ インスタンスにアクセスできます。 IP アドレスホワイトリストを設定した場合、ホワイトリスト内の IP アドレスのみがインターネット経由で Message Queue for Apache RocketMQ インスタンスにアクセスできます。
	string	任意	ホワイトリスト内の IP アドレスまたは CIDR ブロックです。	192.168.x.x/24
commodityCode `deprecated`	string	任意	商品コードです。 `ons_rmqpost_public_intl`：従量課金インスタンス `ons_rmqsub_public_intl`：サブスクリプションインスタンス `ons_rmqsrvlesspost_public_intl`：Serverless Edition インスタンス	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 があります。この 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"
}

エラーコード

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

変更履歴

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