ListAnsServices を使用して Nacos サービスをクエリ - Microservices Engine

Nacos サービスの詳細をクエリします。

操作説明

説明

この OpenAPI は Nacos SDK API ではありません。 Nacos SDK API の詳細については、「公式ドキュメント」をご参照ください。

今すぐお試しください

この 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:ListAnsServices

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ServiceName	string	任意	サービスの名前。	name
GroupName	string	任意	連絡先グループの名前。	name
NamespaceId	string	任意	名前空間の ID。	12233****
ClusterName	string	任意	サービスの特定のクラスタにあるインスタンスの一覧をクエリするために必要なパラメータ。
HasIpCount	string	任意	サービスインスタンスの数をクエリするかどうかを指定します。	true
ClusterId `deprecated`	string	任意	クラスタの ID。説明このパラメータまたはインスタンス ID のいずれかを指定する必要があります。	mse-09k1q11****
InstanceId	string	任意	インスタンスの ID。説明このパラメータまたはクラスタ ID のいずれかを指定する必要があります。	mse-cn-st21v5****
PageNum	integer	必須	ページ番号。	1
PageSize	integer	必須	各ページに表示するインスタンスの数。	10
RegionId	string	任意	リージョン。
RequestPars	string	任意	JSON 形式の拡張リクエストパラメータ。	{}
AcceptLanguage	string	任意	レスポンスの言語。有効な値: zh: 中国語 en: 英語	zh

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	データ構造。
HttpCode	string	HTTP ステータスコード。	202
TotalCount	integer	インスタンスの総数。	7
RequestId	string	リクエストの ID。	52BA6DA6-A702-4362-A32F-DFF79655****
Message	string	返されたメッセージ。	The request was successfully processed.
PageSize	integer	1 ページあたりに表示されるインスタンスの数。	10
PageNumber	integer	ページ番号。	1
Data	array<object>	データの概要。
	object	データ構造。
HealthyInstanceCount	integer	正常なハートビートを持つサービスインスタンスの総数。	1
GroupName	string	連絡先グループの名前。	name
IpCount	integer	現在のサービスのインスタンスの総数。	1
Name	string	サービスの名前。	name
ClusterCount	integer	クラスタの総数。	1
Source	string	サービスの種類。有効な値: コンソール: コンソールに登録されています。 SDK: SDK を使用して登録されています。ガバナンス: サービス管理を使用して登録されています。
ErrorCode	string	エラーコード。	mse-100-000
Success	boolean	リクエストの結果。有効な値: `true`: リクエストは成功しました。 `false`: リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "HealthyInstanceCount": 1,
      "GroupName": "name",
      "IpCount": 1,
      "Name": "name",
      "ClusterCount": 1,
      "Source": ""
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	OperationNotSupport	The current cluster does not support this operation, %s.
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

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

変更履歴

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