GetInstance によるインスタンス詳細の取得 - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

指定されたインスタンスの詳細を取得します。

操作説明

重要 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:GetInstance

get

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエスト構文

GET /instances/{instanceId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	クエリするインスタンスの ID。	rmq-cn-7e22ody****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
requestId	string	リクエスト ID。各リクエストには一意の ID が割り当てられ、問題のトラブルシューティングに使用できます。	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	操作が成功したかどうかを示します。	true。
data	object	応答データ。
regionId	string	インスタンスのリージョン ID。	cn-hangzhou。
instanceId	string	インスタンスの ID。	rmq-cn-7e22ody****
instanceName	string	インスタンス名。	テストインスタンス。
status	string	インスタンスステータス。列挙値: RELEASED : リリース済み。 RUNNING : 実行中。 STOPPED : 停止済み。 CHANGING : 変更中。 CREATING : 作成中。	RUNNING。
startTime	string	インスタンスの開始時刻。	2022-08-01 00:00:00
expireTime	string	インスタンスの有効期限時間。	2022-09-01 00:00:00
releaseTime	string	インスタンスのリリース時間。	2022-09-07 00:00:00
userId	string	インスタンスが属するユーザーの ID。	111111111111111
bid	string	商品の販売チャンネル BID。	26842
commodityCode	string	RocketMQ 5.x キューインスタンス用メッセージキューの商品コード (例: ons_rmqsub_public_cn)。	ons_rmqsub_public_cn。
serviceCode	string	インスタンスのサービスエンコーディング。RocketMQ キュー用メッセージキューのサービスエンコーディングは rmq です。	rmq。
seriesCode	string	インスタンスのプライマリシリーズコード。プライマリシリーズ間の違いについては、「プロダクトの選択」を参照してください。列挙値: standard : Standard Edition。 shared : Shared Edition。 dedicated : Dedicated Edition。 ultimate : Platinum Edition。 professional : Professional Edition。	standard。
subSeriesCode	string	インスタンスのサブシリーズコード。サブシリーズ間の違いについては、「プロダクトの選択」を参照してください。列挙値: serverless : Serverless Edition。 cluster_ha : Cluster high-availability Edition。 single_node : Single-node Edition。	cluster_ha。
paymentType	string	インスタンスの課金方法。列挙値: PayAsYouGo : 従量課金 (ポストペイ)。 Subscription : サブスクリプション (プリペイド)。	Subscription。
remark	string	インスタンスの備考。	これはインスタンスの備考です。
networkInfo	object	ネットワーク情報。
vpcInfo	object	VPC 情報。
vpcId	string	インスタンスに関連付けられた VPC の ID。	vpc-uf6of9452b2pba82c****
vSwitchId `deprecated`	string	インスタンスに関連付けられた vSwitch の ID。	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	vSwitch のリスト。
	object
vSwitchId	string	vSwitch の ID。	vsw-uf6gwtbn6etadpvz7****
zoneId	string	ゾーンの ID。	cn-hangzhou。
securityGroupIds	string	セキュリティグループの ID。	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	エンドポイント情報。
	object	エンドポイント情報。
endpointType	string	インスタンスのエンドポイントタイプ。列挙値: TCP_VPC : VPC エンドポイント。 TCP_INTERNET : パブリックエンドポイント。	TCP_INTERNET。
endpointUrl	string	インスタンスのエンドポイント。	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	パブリックネットワークアクセス用の IP ホワイトリスト。IP ホワイトリストの構成をサポートするのはパブリックエンドポイントのみです。VPC エンドポイントではこの特徴はサポートされていません。	192.168.x.x/24
	string	パブリックネットワークアクセス用の IP ホワイトリスト。	192.168.x.x/24
endpointId	string	関連付けられた PVL EP インスタンス。	ep-bpxxx。
internetInfo	object	インスタンスのパブリックネットワーク情報。
internetSpec	string	パブリックネットワークアクセスが有効かどうかを指定します。列挙値: enable : パブリックネットワークアクセス有効。 disable : パブリックネットワークアクセス無効。	enable。
flowOutType	string	パブリックネットワークの課金タイプ。列挙値: payByBandwidth : 固定帯域幅課金。パブリックネットワークアクセスが有効な場合にこの値を設定します。 uninvolved : 該当なし。パブリックネットワークアクセスが有効でない場合にこの値を設定します。	payByBandwidth。
flowOutBandwidth	integer	インターネット帯域幅の仕様。単位: 1 Mbit/s。	1
ipWhitelist	array	パブリックネットワークアクセス用の IP ホワイトリスト。
	string	パブリックネットワークアクセス用の IP ホワイトリスト。	192.168.x.x/24
accountInfo	object	アカウント情報。
username	string	インスタンスのユーザー名。パブリックネットワークアクセスを使用する場合、クライアントを認証するための本人確認用として、SDK コードでインスタンスのユーザー名とパスワードを設定します。	6W0xz2uPfiwp****
instanceQuotas	array<object>	容量情報。
	object	容量情報。
quotaName	string	インスタンスのクォータ名。列挙値: TOPIC_COUNT : インスタンスの Topic 作成クォータ。	TOPIC_COUNT。
usedCount	number	使用数。単位: 個。	10
freeCount	number	無料クォータ。単位: 個。	20
totalCount	number	合計クォータ。単位: 個。	100
createTime	string	インスタンスの作成時間。	2022-08-01 00:00:00
updateTime	string	インスタンスの最終変更時間。	2022-08-02 00:00:00
extConfig `deprecated`	object	拡張構成。このフィールドは非推奨です。代わりに productInfo、internetInfo、aclInfo の各プロダクト情報およびネットワーク情報フィールドを使用してください。
aclType	string	インスタンスの認証タイプ。列挙値: default : インテリジェント ID 認識。 apache_acl : Apache RocketMQ ACL。	default。
sendReceiveRatio	number	メッセージ送信と受信の比率。	0.5
autoScaling	boolean	仕様外のバースト可能な弾力性が有効かどうかを指定します。列挙値: true : 弾力性有効。 false : 弾力性無効。	true。
messageRetentionTime	integer	メッセージの保持期間。単位: 時間。	72
supportAutoScaling	boolean	インスタンスが仕様外のバースト可能な弾力性をサポートするかどうかを示します。列挙値: true : 弾力性の有効化をサポート。 false : 弾力性の有効化をサポートしない。	true。
internetSpec	string	パブリックネットワークアクセスが有効かどうかを指定します。列挙値: enable : パブリックネットワークアクセス有効。 disable : パブリックネットワークアクセス無効。	enable。
flowOutType	string	パブリックネットワークの課金タイプ。列挙値: payByTraffic : トラフィック課金。 payByBandwidth : 帯域幅課金。 uninvolved : 該当なし。	payByBandwidth。
flowOutBandwidth	integer	インターネット帯域幅の仕様。単位: Mbit/s。	10
msgProcessSpec	string	メッセージ送受信のコンピューティング仕様。具体的な TPS の制限については、「インスタンスの仕様」を参照してください。	rmq.s2.2xlarge。
resourceGroupId	string	リソースグループの ID。	rg-acfm3tmjruyribi。
productInfo	object	インスタンスの拡張構成。
msgProcessSpec	string	メッセージ送受信のコンピューティング仕様。具体的な TPS の制限については、「インスタンスの仕様」を参照してください。	rmq.s2.2xlarge。
sendReceiveRatio	number	メッセージ送信と受信の比率。	0.5
autoScaling	boolean	仕様外のバースト可能な弾力性が有効かどうかを指定します。列挙値: true : 弾力性有効。 false : 弾力性無効。	true。
messageRetentionTime	integer	メッセージの保持期間。単位: 時間。	72
supportAutoScaling	boolean	仕様外のバースト可能な弾力性がサポートされているかどうかを示します。列挙値: true : 弾力性の有効化をサポート。 false : 弾力性の有効化をサポートしない。	true。
traceOn	boolean	メッセージトレース特徴が有効かどうかを示します。	true。
storageEncryption	boolean	ストレージ暗号化が有効かどうかを示します。	false。
storageSecretKey	string	ストレージの暗号鍵。	xxxxx。
capacityType	string	容量モード。列挙値: provisioned : プロビジョニング済み + 弾力的。 ondemand : 従量課金。	provisioned。
provisionedCapacity	integer	プロビジョニング済み容量。	3000
drReplicationMode	string	クロスリージョンのレプリケーションモード。	async_cross_az。
maxDelayTime	integer	スケジュールされたメッセージの最大値間隔。単位: 秒。	3456000
adaptiveElasticity	boolean		false
aclInfo	object	アクセスの制御情報。
aclTypes	array	インスタンスの認証タイプリスト。
	string	インスタンスの認証タイプ。列挙値: default : インテリジェント ID 認識。 apache_acl : ACL ID 認識。	default。
defaultVpcAuthFree	boolean	内部ネットワーク経由の認証不要アクセスが有効かどうかを指定します。列挙値: true : 有効。 false : 無効。	true。
aclType `deprecated`	string	インスタンスの認証タイプ。このフィールドは非推奨です。代わりに aclTypes フィールドを使用してください。列挙値: default : インテリジェント ID 認識。 apache_acl : ACL ID 認識。	default。
software	object	インスタンスのソフトウェア情報。
softwareVersion	string	ソフトウェアのバージョン。	5.0-rmq-20230619-1
maintainTime `deprecated`	string	スペックアップ用のメンテナンスウィンドウ。	02:00-06:00
upgradeMethod	string	スペックアップのメソッド。列挙値: auto : 自動スペックアップ。 maunal : 手動スペックアップ。	auto。
topicCount	integer	Topic の数。	10
groupCount	integer	コンシューマーグループの数。	10
tags	array<object>	リソースタグのリスト。
	object	リソースタグ。
key	string	リソースのタグキー。	key。
value	string	リソースのタグ値。	値
autoRenew	boolean	自動更新が有効になっているかどうかを示します。	false。
autoRenewPeriod	integer	自動更新が有効になっているかどうかを示します。	false。
code	string	エラーコード。	MissingInstanceId。
message	string	エラーメッセージ。	パラメーター instanceId は、この操作では必須です。
httpStatusCode	integer	HTTP 状態コード。	400
dynamicCode	string	動的エラーコード。	InstanceId。
dynamicMessage	string	動的エラーメッセージ。	インスタンス ID

例

成功レスポンス

JSONJSON

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou。",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "テストインスタンス",
    "status": "RUNNING。",
    "startTime": "2022-08-01 00:00:00",
    "expireTime": "2022-09-01 00:00:00",
    "releaseTime": "2022-09-07 00:00:00",
    "userId": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn。",
    "serviceCode": "rmq。",
    "seriesCode": "standard。",
    "subSeriesCode": "cluster_ha。",
    "paymentType": "Subscription。",
    "remark": "これはインスタンスの備考です。",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou。"
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET。",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx。"
        }
      ],
      "internetInfo": {
        "internetSpec": "enable。",
        "flowOutType": "payByBandwidth。",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT。",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default。",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable。",
      "flowOutType": "payByBandwidth。",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge。"
    },
    "resourceGroupId": "rg-acfm3tmjruyribi。",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge。",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": true,
      "storageSecretKey": "xxxxx。",
      "capacityType": "provisioned。",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az。",
      "maxDelayTime": 3456000,
      "adaptiveElasticity": false
    },
    "aclInfo": {
      "aclTypes": [
        "default。"
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default。"
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto。"
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "key。",
        "value": "値"
      }
    ],
    "autoRenew": true,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId。",
  "message": "このアクションにはパラメーター instanceId が必須です。",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId。",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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