DescribeHubClusters - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

Distributed Cloud Container Platform for Kubernetes (ACK One) クラスター内のフリートインスタンスを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adcp:DescribeHubClusters

list

*Cluster

acs:adcp::{#accountId}:cluster/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Profile	string	任意	さまざまなシナリオで使用されるフリートインスタンスのタイプ。有効な値： `Default`：標準シナリオに適したフリートインスタンス。 `XFlow`：ワークフローシナリオに適したフリートインスタンス。デフォルト値：`Default`。	Default
ResourceGroupId	string	任意	リソースグループ ID。	rg-aek3dinj3xkf***
Tag	array	任意	タグ。最大 20 個のタグを指定できます。
	Tag	任意	タグ。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	2D676EFC-8C04-5CCE-A08E-BB97D24B47E8
Clusters	array<object>	クラスターに関する情報。
	array<object>	クラスター情報。
Endpoints	object	クラスターのエンドポイント。
IntranetApiServerEndpoint	string	API サーバーの内部エンドポイント。	https://172.16.6.**:6443
PublicApiServerEndpoint	string	API サーバーのパブリックエンドポイント。	https://123.57.21.***:6443
ClusterInfo	object	クラスターの詳細。
Profile	string	クラスターの構成。	Default
CreationTime	string	クラスターが作成された時間。	2021-11-05T10:25:48Z
UpdateTime	string	クラスターが最後に変更された時間。	2021-09-02T13:39:50Z
ErrorMessage	string	クラスターの作成に失敗した場合に返されるエラーメッセージ。	Success
Version	string	クラスターのバージョン。	1.22.3-aliyun.1
State	string	クラスターの状態。有効な値： initial：クラスターは初期化中です。 failed：クラスターの作成に失敗しました。 running：クラスターは実行中です。 inactive：クラスターはアクティブ化されていません。 deleting：クラスターは削除中です。 delete_failed：クラスターの削除に失敗しました。 deleted：クラスターは削除されました。	running
ClusterId	string	クラスター ID。	c2d3e0121ea214b438010502a8019****
Name	string	クラスター名。	ackone-heyuan
RegionId	string	リージョン ID。	cn-beijing
ClusterSpec	string	クラスターの仕様。 ack.pro.small のみが返される場合があります。	ack.pro.small
ResourceGroupID	string	リソースグループ ID。	rg-dt6rk4xm1r6***
Tags	array<object>	タグ。
	object	タグ。
Key	string	タグキー。	headername
Value	string	タグ値。	release
Network	object	クラスターのネットワーク構成。
VpcId	string	クラスターが属する VPC (Virtual Private Cloud) の ID。	vpc-2zeusrwi7c2mlww4a****
VSwitches	array	クラスターが属する vSwitch の ID。
	string	vSwitch ID。	["vsw-2ze1h7tt2fgr1gxlx****"]
SecurityGroupIDs	array	セキュリティグループ ID。
	string	セキュリティグループ ID。	["sg-2ze1h7tt2fgr****"]
ClusterDomain	string	クラスターのドメイン名。	cluster.local
ApiServer	object	API サーバーに関する情報。
EnabledPublic	boolean	API サーバーのパブリックエンドポイントが有効になっているかどうかを示します。有効な値： true false	true
LoadBalancerId	string	クラスターに関連付けられている Server Load Balancer (SLB) インスタンスの ID。	lb-bp1qyp4l6bscqxw69****
ApiServerEipId	string	EIP (Elastic IP) ID。	eip-xxx
MeshConfig	object	Alibaba Cloud Service Mesh (ASM) の構成。
EnableMesh	boolean	ASM が有効になっているかどうかを示します。有効な値： true false	false
MeshId	string	ASM インスタンス ID。	c2d3e0121ea214b438010502a8019****
LogConfig	object	ログ構成。
EnableLog	boolean	監査ログ機能が有効になっているかどうかを示します。有効な値： true false	true
LogProject	string	Simple Log Service 内のプロジェクトの名前。	audit-log-abc
LogStoreTTL	string	Simple Log Service によってログが保持される日数。	7
Conditions	array<object>	クラスターの削除条件。
	object	条件の詳細。
Type	string	削除条件のタイプ。	DeletionProtection
Status	string	削除条件が示すクラスターの状態。有効な値： True：クラスターは削除できません。 False：クラスターは削除できます。 Unknow：クラスターを削除できるかどうかは不明です。	True
Reason	string	削除条件の理由。	Successful
Message	string	返されたエラーメッセージ。	Successful!

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D676EFC-8C04-5CCE-A08E-BB97D24B47E8",
  "Clusters": [
    {
      "Endpoints": {
        "IntranetApiServerEndpoint": "https://172.16.6.**:6443\n",
        "PublicApiServerEndpoint": "https://123.57.21.***:6443\n"
      },
      "ClusterInfo": {
        "Profile": "Default",
        "CreationTime": "2021-11-05T10:25:48Z",
        "UpdateTime": "2021-09-02T13:39:50Z",
        "ErrorMessage": "Success",
        "Version": "1.22.3-aliyun.1\n",
        "State": "running",
        "ClusterId": "c2d3e0121ea214b438010502a8019****",
        "Name": "ackone-heyuan",
        "RegionId": "cn-beijing",
        "ClusterSpec": "ack.pro.small",
        "ResourceGroupID": "rg-dt6rk4xm1r6***",
        "Tags": [
          {
            "Key": "headername",
            "Value": "release"
          }
        ]
      },
      "Network": {
        "VpcId": "vpc-2zeusrwi7c2mlww4a****",
        "VSwitches": [
          "[\"vsw-2ze1h7tt2fgr1gxlx****\"]"
        ],
        "SecurityGroupIDs": [
          "[\"sg-2ze1h7tt2fgr****\"]\n"
        ],
        "ClusterDomain": "cluster.local"
      },
      "ApiServer": {
        "EnabledPublic": true,
        "LoadBalancerId": "lb-bp1qyp4l6bscqxw69****",
        "ApiServerEipId": "eip-xxx"
      },
      "MeshConfig": {
        "EnableMesh": false,
        "MeshId": "c2d3e0121ea214b438010502a8019****"
      },
      "LogConfig": {
        "EnableLog": true,
        "LogProject": "audit-log-abc",
        "LogStoreTTL": "7"
      },
      "Conditions": [
        {
          "Type": "DeletionProtection",
          "Status": "True",
          "Reason": "Successful",
          "Message": "Successful!"
        }
      ]
    }
  ]
}

エラーコード

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

変更履歴

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