マイクロサービス治理用 Kubernetes クラスターのクエリ - MSE - Alibaba Cloud - Microservices Engine

マイクロサービス管理のために Kubernetes クラスターをクエリします。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterName	string	任意	Kubernetes クラスターの名前。	example-cluster
ClusterId	string	任意	Kubernetes クラスターの ID。	c24c9354acxxxxxxx
PageNumber	integer	必須	ページ番号。	1
PageSize	integer	必須	1ページあたりのエントリ数。	10
AcceptLanguage	string	任意	応答の言語。有効な値： `zh`：中国語 `en`：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
Message	string	応答メッセージ。	success
RequestId	string	リクエスト ID。	DE34D413-2B79-5E77-9696-36D875E822AD
Data	object	応答で返されるデータ。
Result	array<object>	クラスターオブジェクトのリスト。
	object	クラスターの詳細。
ClusterName	string	クラスター名。	example-cluster
ClusterId	string	クラスター ID。	abcdef123456789
Region	string	クラスターが配置されているリージョン。	cn-shanghai
K8sVersion	string	Kubernetes バージョン。	1.22
NamespaceInfos	string	名前空間オブジェクトの配列を含む JSON 文字列。	[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]
PilotStartTime	string	Pilot が開始した時間。協定世界時 (UTC、ISO 8601 形式) です。	2022-05-17T05:39:43.000+0000
VersionLifeCycle	string	バージョンのライフサイクルステータス。
PilotVersion	string	Pilot バージョン。
TotalSize	integer	クエリに一致するクラスターの総数。	3
PageNumber	integer	現在のページ番号。	1
PageSize	integer	1ページあたりのエントリ数。	10
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "Message": "success",
  "RequestId": "DE34D413-2B79-5E77-9696-36D875E822AD",
  "Data": {
    "Result": [
      {
        "ClusterName": "example-cluster",
        "ClusterId": "abcdef123456789",
        "Region": "cn-shanghai",
        "K8sVersion": "1.22",
        "NamespaceInfos": "[{\"Name\":\"ack-onepilot\",\"Tags\":{\"name\":\"ack-onepilot\"}}]",
        "PilotStartTime": "2022-05-17T05:39:43.000+0000",
        "VersionLifeCycle": "",
        "PilotVersion": ""
      }
    ],
    "TotalSize": 3,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Success": 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

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

変更履歴

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