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

*インスタンス。

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	インスタンスが起動された時刻。フォーマットは YYYY-MM-DD HH:mm:ss です。	2022-08-01 00:00:00
expireTime	string	インスタンスの有効期限が切れる時刻。フォーマットは YYYY-MM-DD HH:mm:ss です。	2022-09-01 00:00:00
releaseTime	string	インスタンスがリリースされた時刻。フォーマットは YYYY-MM-DD HH:mm:ss です。	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 : サーバーレスエディション。 cluster_ha : クラスター高可用性エディション。 single_node : シングルノードエディション。	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。重要このフィールドは推奨されません。代わりに vSwitches フィールドを使用してください。互換性のため、現在このフィールドは 1 つの vSwitch のみを返します。	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 エンドポイントではサポートされていません。 IP ホワイトリストが設定されていない場合、デフォルトですべての IP アドレスからインターネット経由で RocketMQ 用メッセージキューのブローカーにアクセスできます。 IP ホワイトリストが設定されている場合、ホワイトリスト内の IP アドレスからのみインターネット経由で RocketMQ 用メッセージキューのブローカーにアクセスできます。このフィールドは推奨されなくなりました。代わりに internetInfo.ipWhitelist フィールドを使用してください。	192.168.x.x/24
	string	パブリックネットワークアクセス用の IP ホワイトリスト。	192.168.x.x/24
endpointId	string	関連付けられた PrivateLink エンドポイントインスタンス。	ep-bpxxx
internetInfo	object	インスタンスのパブリックネットワーク情報。
internetSpec	string	パブリックネットワークアクセスが有効かどうかを示します。インスタンスはデフォルトで VPC アクセスをサポートしています。パブリックネットワークアクセスが有効な場合、ApsaraMQ for RocketMQ はパブリックダウンストリーム帯域幅に対して課金されます。課金の詳細については、「パブリックネットワークアクセス料金」を参照してください。列挙値: enable : パブリックネットワークアクセスは有効です。 disable : パブリックネットワークアクセスは無効です。	enable
flowOutType	string	パブリックネットワーク使用量の課金タイプ。列挙値: payByBandwidth : 固定帯域幅課金。パブリックネットワークアクセスが有効な場合にこの値が返されます。 uninvolved : 該当なし。パブリックネットワークアクセスが有効でない場合にこの値が返されます。	payByBandwidth
flowOutBandwidth	integer	インターネット帯域幅の仕様。単位: Mbit/s。	1
ipWhitelist	array	パブリックネットワークアクセス用の IP ホワイトリスト。 IP ホワイトリストが設定されていない場合、デフォルトですべての IP アドレス範囲からパブリックネットワーク経由で ApsaraMQ for RocketMQ ブローカーへのアクセスが許可されます。 IP ホワイトリストが設定されている場合、ホワイトリスト内の IP アドレスからのみパブリックネットワーク経由で ApsaraMQ for RocketMQ ブローカーへのアクセスが許可されます。
	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	インスタンスが作成された時刻。値は YYYY-MM-DD HH:mm:ss フォーマットです。	2022-08-01 00:00:00
updateTime	string	インスタンスが最後に変更された時刻。値は YYYY-MM-DD HH:mm:ss フォーマットです。	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	基本仕様を超えるバースト可能な弾力的容量が有効かどうかを示します。このパラメーターは、supportAutoScaling の値が enable (インスタンスが弾力的容量の有効化をサポートしていることを意味する) の場合にのみ効果があります。列挙値: true : 弾力的容量は有効です。 false : 弾力的容量は有効ではありません。	true
messageRetentionTime	integer	メッセージ保持期間。単位: 時間。有効値については、「使用制限」>「リソースクォータ」>「メッセージ保持期間」を参照してください。 ApsaraMQ for RocketMQ のメッセージストレージは完全にサーバーレスで弾力的です。実際に使用されたストレージスペースに基づいて課金されます。メッセージ保持期間を調整することでストレージ容量をコントロールできます。詳細については、「ストレージ料金」を参照してください。	72
supportAutoScaling	boolean	インスタンスが基本仕様を超えるバースト可能な弾力的容量の有効化をサポートしているかどうかを示します。バースト可能な弾力的容量が有効化されると、ApsaraMQ for RocketMQ はインスタンスが一定の範囲内で基本仕様の TPS 制限を超えることを許可します。基本仕様を超える部分については、追加の弾力的仕様料金が課金されます。課金の詳細については、「コンピューティング料金」を参照してください。説明特定の仕様のインスタンスのみがバースト可能な弾力的容量をサポートしています。サポートされているインスタンスの詳細については、「インスタンスの仕様」を参照してください。列挙値: true : 弾力的容量の有効化はサポートされています。 false : 弾力的容量の有効化はサポートされていません。	true
internetSpec	string	パブリックネットワークアクセスが有効かどうかを示します。インスタンスはデフォルトで VPC アクセスをサポートしています。パブリックネットワークアクセスが有効な場合、ApsaraMQ for RocketMQ はパブリックダウンストリーム帯域幅に対して課金されます。課金の詳細については、「パブリックネットワークアクセス料金」を参照してください。列挙値: 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	シームレスなスケーリングのために、基本仕様を超えるバースト可能な弾力的容量が有効かどうかを示します。このパラメーターは、supportAutoScaling の値が enable (インスタンスが弾力的容量の有効化をサポートしていることを意味する) の場合にのみ効果があります。列挙値: true : 弾力的容量は有効です。 false : 弾力的容量は有効ではありません。	true
messageRetentionTime	integer	メッセージの保持期間。単位: 時間。有効値については、使用制限 > リソースクォータ > メッセージの保持期間をご参照ください。 ApsaraMQ for RocketMQ のメッセージストレージは、完全にサーバーレスで弾力的です。実際の使用ストレージスペースに基づいて課金されます。メッセージの保持期間を調整することでストレージ容量をコントロールできます。詳細については、ストレージ料金をご参照ください。	72
supportAutoScaling	boolean	基本仕様を超えるバースト可能な弾力的スケーリング機能が有効かどうかを示します。バースト可能な弾力的スケーリング機能を有効にすると、ApsaraMQ for RocketMQ では、インスタンスが一定の範囲内で基本仕様の TPS 制限を超えることが許可されます。基本仕様を超える部分については、追加の弾力的スケーリング仕様料金が発生します。課金の詳細については、コンピュート機能料金をご参照ください。説明特定の仕様のインスタンスのみがバースト可能な弾力的スケーリング機能をサポートしています。サポートされているインスタンスの詳細については、インスタンスの仕様をご参照ください。列挙値: true : 弾力的容量の有効化はサポートされています。 false : 弾力的容量の有効化はサポートされていません。	true
traceOn	boolean	メッセージトレース特徴が有効かどうかを示します。 true: メッセージトレース特徴が有効です。 false: メッセージトレース特徴が無効です。このパラメーターに効果はありません。このパラメーターが有効かどうかに関わらず、インスタンスはデフォルトでメッセージトレース特徴をサポートしています。	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 認識。	デフォルト
defaultVpcAuthFree	boolean	VPC 内の認証不要特徴が有効かどうかを示します。列挙値: true : 有効。 false : 無効。	true
aclType `deprecated`	string	インスタンスの認証タイプ。このパラメーターは非推奨です。代わりに aclTypes パラメーターを使用してください。列挙値: default : インテリジェント ID 認識。 apache_acl : ACL ID 認識。	デフォルト
software	object	インスタンスのソフトウェア情報。
softwareVersion	string	ソフトウェアバージョン。	5.0-rmq-20230619-1
maintainTime `deprecated`	string	スペックアップのタイムウィンドウ。フォーマットは HH:mm-HH:mm です。	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	エラーメッセージ。	この操作にはパラメーターインスタンス ID が必須です。
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": true
    },
    "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": "value"
      }
    ],
    "autoRenew": true,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId。",
  "message": "パラメーター instanceId は、この操作では必須です。",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId。",
  "dynamicMessage": "インスタンス ID"
}

エラーコード

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

変更履歴

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