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

ApsaraMQ for RocketMQ 5.x シリーズのインスタンスを作成します。

操作説明

重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスのリソースを管理およびクエリするために使用される管理コントロール 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/*

rocketmq:InternetSpec

なし

リクエスト構文

POST /instances HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
clientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。	c2c5d1274a8d4317a13bc5b0d4******
body	object	任意	本文パラメーター。
instanceName	string	任意	作成するインスタンスの名前。	rmq-cn-72u3048uxxx。
serviceCode	string	必須	インスタンスのサービスエンコーディング。メッセージキュー RocketMQ のサービスエンコーディングは rmq です。	rmq。
seriesCode	string	必須	インスタンスのプライマリシリーズエンコーディング。プライマリシリーズ間の違いの詳細については、「プロダクト選択」をご参照ください。列挙値: standard : Standard Edition。 ultimate : Platinum Edition。 professional : Professional Edition。 dedicated : Dedicated Edition。 shared : Shared Edition。	standard。
subSeriesCode	string	必須	インスタンスのサブシリーズエンコーディング。サブシリーズ間の違いの詳細については、「プロダクト選択」をご参照ください。列挙値: serverless : Serverless Edition。 cluster_ha : Cluster high availability edition。 single_node : Single-node testing edition。	cluster_ha。
paymentType	string	必須	インスタンスの課金タイプ。メッセージキュー RocketMQ はサブスクリプションと従量課金をサポートしています。列挙値: PayAsYouGo : 従量課金。リソースを先に使用し、後で支払うポストペイパターンです。 Subscription : サブスクリプション。先に支払い、後でリソースを使用するプリペイパターンです。	Subscription。
period	integer	任意	サブスクリプション期間。このパラメーターは、インスタンスの課金タイプが Subscription の場合にのみ有効です。	3
periodUnit	string	任意	サブスクリプション期間の最小エポック単位。列挙値: Month : 月間サブスクリプション。 Year : 年間サブスクリプション。	Month。
autoRenew	boolean	任意	自動更新を有効にするかどうかを指定します。このパラメーターは、インスタンスの課金タイプが Subscription の場合にのみ有効です。列挙値: true : 自動更新を有効にします。 false : 自動更新を無効にします。	true。
autoRenewPeriod	integer	任意	統一自動更新サイクル。このパラメーターは、自動更新が有効な場合にのみ有効です。単位: 月。	3
remark	string	任意	インスタンスの備考。	This is the remark for test.
productInfo	object	任意	インスタンスの仕様情報。
msgProcessSpec	string	任意	メッセージ送受信のコンピューティング仕様。メッセージ送受信の TPS 上限の詳細については、「インスタンスの仕様」をご参照ください。	rmq.s2.2xlarge。
sendReceiveRatio	number	任意	インスタンスのメッセージ送信 TPS とメッセージ送受信合計 TPS の比率。	0.5
autoScaling	boolean	任意	仕様を超えるバースト可能な弾力的スケーリングを有効にするかどうかを指定します。列挙値: true : 弾力的スケーリングを有効にします。 false : 弾力的スケーリングを無効にします。	true。
messageRetentionTime	integer	任意	メッセージの保持期間。単位: 時間。	72
storageEncryption	boolean	任意	ストレージ暗号化が有効かどうかを示します。	false。
storageSecretKey	string	任意	ストレージ暗号化のキー。	xxxxx。
capacityType	string	任意	容量パターン。列挙値: provisioned : プロビジョニング済み + 弾力的。 ondemand : 従量課金。	provisioned。
provisionedCapacity	integer	任意	プロビジョニング済み容量。	5000
traceOn	boolean	任意	メッセージトレース機能が有効かどうかを示します。	true。
drReplicationMode	string	任意	クロスリージョンレプリケーションパターン。列挙値: async_cross_az : 非同期レプリケーション。 sync_cross_az : 同期レプリケーション。	async_cross_az。
adaptiveElasticity	boolean	任意
networkInfo	object	必須	ネットワーク構成情報。
vpcInfo	object	必須	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_cn。
resourceGroupId	string	任意	リソースグループの ID。	rg-aekzy6pist7uuna。
tags	array<object>	任意	リソースタグのリスト。
	object	任意	リソースタグ。
key	string	任意	リソースタグのキー。	xxxKey。
value	string	任意	リソースタグの値。	xxxValue。
aclInfo	object	任意	アクセスコントロール情報。
defaultVpcAuthFree	boolean	任意	インテリジェント ID 認識タイプを使用する場合に、VPC エンドポイントからの認証フリーアクセスを許可するかどうかを指定します。	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	動的エラーメッセージ。	インスタンス ID

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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