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	インスタンス名。	test instance
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	ApsaraMQ for RocketMQ 5.x インスタンスの商品コード (例: ons_rmqsub_public_cn)。	ons_rmqsub_public_cn
serviceCode	string	インスタンスのサービスコード。ApsaraMQ for RocketMQ のサービスコードは rmq です。	rmq
seriesCode	string	インスタンスのプライマリシリーズコード。プライマリシリーズ間の違いについては、「エディションの選択」を参照してください。列挙値: standard : Standard エディション。 shared : Shared エディション。 dedicated : Dedicated エディション。 ultimate : Platinum エディション。 professional : Professional エディション。	standard
subSeriesCode	string	インスタンスのサブシリーズコード。サブシリーズ間の違いについては、「エディションの選択」を参照してください。列挙値: serverless : Serverless エディション。 cluster_ha : Cluster high-availability エディション。 single_node : Single-node エディション。	cluster_ha
paymentType	string	インスタンスの課金タイプ。列挙値: PayAsYouGo : 従量課金 (ポストペイ)。 Subscription : サブスクリプション (プリペイ)。	Subscription
remark	string	インスタンスの備考。	This is remark for instance.
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 アドレス範囲がパブリックネットワーク経由で ApsaraMQ for RocketMQ サーバーにアクセスできます。 IP ホワイトリストが構成されている場合、ホワイトリスト内の IP アドレスのみがパブリックネットワーク経由で ApsaraMQ for RocketMQ サーバーにアクセスできます。このフィールドは非推奨です。代わりに internetInfo.ipWhitelist フィールドを使用してください。	192.168.x.x/24
	string	パブリックネットワークアクセス用の IP ホワイトリスト。	192.168.x.x/24
endpointId	string	関連付けられた PVL EP インスタンス。	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	インスタンスの作成時間。	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	スペックを超えるバースト可能な弾力的容量が有効かどうかを指定します。このパラメーターは、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
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	リソースのタグ値。	value
autoRenew	boolean	自動更新が有効かどうかを示します。	false
autoRenewPeriod	integer	自動更新が有効かどうかを示します。	false
code	string	エラーコード。	MissingInstanceId
message	string	エラーメッセージ。	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状態コード。	400
dynamicCode	string	動的エラーコード。	InstanceId
dynamicMessage	string	動的エラーメッセージ。	instanceId

例

成功レスポンス

JSONJSON

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "test instance",
    "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": "This is remark for instance.",
    "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": false,
      "storageSecretKey": "xxxxx",
      "capacityType": "provisioned",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az",
      "maxDelayTime": 3456000
    },
    "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": false,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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