Microservices Engine における QueryInstancesInfo - MSE

指定されたクラスターのランタイムデータを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:QueryInstancesInfo

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	任意	クラスターの ID。	mse-09k1q11****
InstanceId	string	任意	インスタンスの ID。	mse_prepaid_public_cn-tl32g1u9k01
OrderId	string	任意	注文の ID。	20574710974****
RegionId	string	任意	インスタンスが存在するリージョンの ID。	cn-hangzhou
RequestPars	string	任意	JSON フォーマットの拡張リクエストパラメーター。	{}
AcceptLanguage	string	任意	応答の言語。有効な値： zh：中国語 en：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	BaseResult
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
Message	string	返されるメッセージ。リクエストが成功した場合、成功メッセージが返されます。リクエストが失敗した場合、エラーメッセージが返されます。	The request is successfully processed.
RequestId	string	リクエストの ID。	54973C90-F379-4372-9AA5-053A3F7****
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	mse-100-000
HttpCode	string	HTTP ステータスコード。	202
Data	array<object>	データの詳細。
	object	データの詳細。
HealthStatus	string	予約済みのパラメーター。	null
Role	string	予約済みのパラメーター。	null
PodName	string	Pod 名。	mse-xxxxx-xxxxx-reg-center-0-1
Ip	string	Pod の IP アドレス。	25.24.91.x
InternetIp	string	パブリック IP アドレス。	120.55.71.x
SingleTunnelVip	string	内部 IP アドレス。	172.16.66.x
CreationTimestamp	string	作成時間。	2022-12-15T02:02:15Z
ClientPort	string	有効なポート。	8848
Zone	string	ゾーン ID。	cn-hangzhou-k
ZoneDistributed	boolean	クラスター内のすべての Pod が指定されたゾーンに分散されているかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "Message": "The request is successfully processed.\n",
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "ErrorCode": "mse-100-000",
  "HttpCode": "202",
  "Data": [
    {
      "HealthStatus": "null",
      "Role": "null",
      "PodName": "mse-xxxxx-xxxxx-reg-center-0-1",
      "Ip": "25.24.91.x",
      "InternetIp": "120.55.71.x",
      "SingleTunnelVip": "172.16.66.x",
      "CreationTimestamp": "2022-12-15T02:02:15Z",
      "ClientPort": "8848",
      "Zone": "cn-hangzhou-k",
      "ZoneDistributed": true
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

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

変更履歴

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