すべてのプロダクト
Search
ドキュメントセンター

Container Service for Kubernetes:DescribeClusterResources

最終更新日:Apr 04, 2026

DescribeClusterResources API オペレーションを呼び出して、クラスター ID に基づいてクラスター内のすべてのリソースをクエリできます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:DescribeClusterResources

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし なし

リクエスト構文

GET /clusters/{ClusterId}/resources HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

ClusterId

string

必須

クラスター ID。

クラスター ID のクエリ方法の詳細については、「クラスター情報の表示」をご参照ください。

また、DescribeClustersV1 API オペレーションを呼び出して、Alibaba Cloud アカウントに属するすべてのクラスターをクエリすることもできます。

cb95aa626a47740afbf6aa099b65****

リクエストパラメーター

パラメーター

必須 / 任意

説明

with_addon_resources

boolean

任意

クラスターコンポーネントによって作成されたリソースをクエリするかどうかを指定します。

false

レスポンスフィールド

フィールド

説明

array

クラスター内のリソースのリスト。

array<object>

リソースの詳細。

cluster_id

string

クラスター ID。

cb95aa626a47740afbf6aa099b65****

created

string

リソースが作成された時間。

2023-08-15T14:34:42+08:00

instance_id

string

リソース ID。

ngw-wz9sphwk42sdtjixo****

resource_info

string

リソース情報。リソースのソース情報のクエリ方法の詳細については、「ListStackResources」をご参照ください。

{\"Id\":\"KubernetesWorkerRole\",\"Name\":\"KubernetesWorkerRole\",\"Type\":\"ALIYUN::RAM::Role\",\"Status\":\"CREATE_COMPLETE\",\"StatusReason\":\"state changed\",\"Updated\":\"2025-04-10T06:21:17\",\"PhysicalId\":\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\"}

resource_type

string

リソースタイプ。

ALIYUN::VPC::NatGateway

state

string

リソースのステータス。有効な値:

  • CREATE_COMPLETE:リソースは作成済みです。

  • CREATE_FAILED:リソースの作成に失敗しました。

  • CREATE_IN_PROGRESS:リソースは作成中です。

  • DELETE_FAILED:リソースの削除に失敗しました。

  • DELETE_IN_PROGRESS:リソースは削除中です。

  • ROLLBACK_COMPLETE:リソースはロールバック済みです。

  • ROLLBACK_FAILED:リソースのロールバックに失敗しました。

  • ROLLBACK_IN_PROGRESS:リソースはロールバック中です。

CREATE_COMPLETE

auto_create

integer

リソースが Container Service for Kubernetes (ACK) によって作成されたかどうかを指定します。有効な値:

  • 1:リソースは ACK によって作成されます。

  • 0:リソースは既存のリソースです。

1

dependencies

array<object>

依存リソース。

object

依存リソースの詳細。

cluster_id

string

依存リソースが関連付けられているクラスターの ID。

cc5ee03f63e43425cb6f71f1a1756****

resource_type

string

依存リソースタイプ。

ALIYUN::VPC::NatGateway

instance_id

string

依存リソース ID。

ngw-wz9sphwk42sdtjixo****

associated_object

object

リソースが関連付けられている Kubernetes オブジェクト。

kind

string

Kubernetes オブジェクトタイプ。

Service

namespace

string

Kubernetes オブジェクトが存在する名前空間。

kube-system

name

string

Kubernetes オブジェクト名。

nginx-ingress-lb

delete_behavior

object

クラスターが削除されたときのリソースの削除動作。

delete_by_default

boolean

クラスターが削除されたときに、デフォルトでリソースを削除するかどうかを指定します。

false

changeable

boolean

delete_by_default で返されるデフォルトの動作を変更できるかどうかを指定します。

false

creator_type

string

リソース作成者のタイプ。有効な値:

  • user:リソースはユーザーによって作成されます。

  • system:リソースは ACK 管理システムによって作成されます。

  • addon:リソースはクラスターコンポーネントによって作成されます。

addon

extra_info

object

リソースに関する追加情報。

{ "type": "SLS_Data" }

成功レスポンス

JSONJSON

[
  {
    "cluster_id": "cb95aa626a47740afbf6aa099b65****",
    "created": "2023-08-15T14:34:42+08:00",
    "instance_id": "ngw-wz9sphwk42sdtjixo****",
    "resource_info": "{\\\"Id\\\":\\\"KubernetesWorkerRole\\\",\\\"Name\\\":\\\"KubernetesWorkerRole\\\",\\\"Type\\\":\\\"ALIYUN::RAM::Role\\\",\\\"Status\\\":\\\"CREATE_COMPLETE\\\",\\\"StatusReason\\\":\\\"state changed\\\",\\\"Updated\\\":\\\"2025-04-10T06:21:17\\\",\\\"PhysicalId\\\":\\\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\\\"}",
    "resource_type": "ALIYUN::VPC::NatGateway",
    "state": "CREATE_COMPLETE",
    "auto_create": 1,
    "dependencies": [
      {
        "cluster_id": "cc5ee03f63e43425cb6f71f1a1756****",
        "resource_type": "ALIYUN::VPC::NatGateway",
        "instance_id": "ngw-wz9sphwk42sdtjixo****"
      }
    ],
    "associated_object": {
      "kind": "Service",
      "namespace": "kube-system",
      "name": "nginx-ingress-lb"
    },
    "delete_behavior": {
      "delete_by_default": false,
      "changeable": false
    },
    "creator_type": "addon",
    "extra_info": {
      "type": "SLS_Data"
    }
  }
]

エラーコード

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

変更履歴

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