すべてのプロダクト
Search

このプロダクト

    Container Service for Kubernetes:ListClusterKubeconfigStates

    ドキュメントセンター

    Container Service for Kubernetes:ListClusterKubeconfigStates

    最終更新日:Apr 04, 2026

    現在のクラスターのアクセス制御ステータスを確認するには、ListClusterKubeconfigStates API を呼び出します。この API により、クラスターのユーザーに発行された kubeconfig 構成のリストとステータスを取得できます。

    操作説明

    説明

    • この API を呼び出すには、ram:ListUsers および ram:ListRoles 権限が必要です。

    • この API を呼び出すには、Container Service (CS) を管理する権限 (AliyunCSFullAccess) が必要です。

    今すぐお試しください

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

    none

    *Cluster

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

    		 なし なし

    リクエスト構文

    GET /clusters/{ClusterId}/kubeconfig/states HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClusterId

    string

    任意

    クラスターの ID。

    c82e6987e2961451182edacd74faf****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    pageNumber

    integer

    任意

    ページ番号。

    • 有効値：≥ 1。

    • デフォルト値：1。

    1
    pageSize

    integer

    任意

    1 ページあたりのエントリ数。

    • 有効値：10～50。

    • デフォルト値：10

    10
    cloudServiceKubeConfig

    boolean

    任意

    クラスター内のクラウドプロダクトのサービスロールの kubeconfig リストをクエリするかどうか。

    • true：クラスター内のクラウドプロダクトのサービスロールの kubeconfig リストをクエリします。

    • false：クラスター内の Resource Access Management (RAM) ユーザーまたはロールの kubeconfig リストをクエリします。

    列挙値:

    • true :

      true

    • false :

      false

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディ。

    states

    array<object>

    クラスターに関連付けられた kubeconfig ファイルのステータスリスト。

    array<object>

    account_id

    string

    Alibaba Cloud アカウント、RAM ユーザー、または RAM ロールの ID。

    22855*****************
    account_name

    string

    RAM ユーザーのログイン名またはロール名。

    tom
    account_display_name

    string

    RAM ユーザーの表示名またはロール名。

    tom
    account_type

    string

    アカウントのタイプ。

    • RootAccount：Alibaba Cloud アカウント。

    • RamUser：RAM ユーザー。

    • RamRole：RAM ロール。

    RamUser
    account_state

    string

    アカウントのステータス。

    • Active：アカウントはアクティブです。

    • InActive：アカウントはロックされています。

    • Deleted：アカウントは削除されています。

    Active
    cert_expire_time

    string

    kubeconfig ファイルのクライアント証明書の有効期限。

    2027-07-15T01:32:20Z
    cert_state

    string

    kubeconfig ファイルのクライアント証明書のステータス。

    • Unexpired：証明書は有効期限内です。

    • Expired：証明書は期限切れです。

    • Unknown：証明書のステータスは不明です。

    Expired
    revokable

    boolean

    kubeconfig ファイルのクライアント証明書を取り消すことができるかどうかを示します。

    true
    cloud_service_name

    string

    クラウドサービス名。

    cs/ecs/sls
    cloud_service_roles

    array<object>

    クラスターのクラウドプロダクトのサービスロールに関連付けられたクラスターロールのリスト。

    object

    クラスターのクラウドプロダクトのサービスロールに関連付けられたクラスターロールに関する情報。

    type

    string

    クラスターのクラウドサービスロールに関連付けられたクラスターロールのタイプ。

    列挙値:

    • Role :

      Role

    • ClusterRole :

      ClusterRole

    ClusterRole
    role_name

    string

    クラスターのクラウドプロダクトのサービスロールに関連付けられたクラスターロールの名前。

    cluster-admin
    role_namespace

    string

    クラスターのクラウドプロダクトのサービスロールに関連付けられたクラスターロールの名前空間。

    kube-system
    is_default_template

    boolean

    コンテンツがデフォルトのクラスターロールテンプレートと一致するかどうかを示します。

    • true：一致します

    • false：一致しません

    page

    object

    ページネーション情報。

    page_number

    integer

    ページ番号。

    1
    page_size

    integer

    1 ページあたりのエントリ数。

    10
    total_count

    integer

    返されたエントリの総数。

    5

    例

    成功レスポンス

    JSONJSON

    {
  "states": [
    {
      "account_id": "22855*****************",
      "account_name": "tom",
      "account_display_name": "tom",
      "account_type": "RamUser",
      "account_state": "Active",
      "cert_expire_time": "2027-07-15T01:32:20Z",
      "cert_state": "Expired",
      "revokable": true,
      "cloud_service_name": "cs/ecs/sls",
      "cloud_service_roles": [
        {
          "type": "ClusterRole",
          "role_name": "cluster-admin",
          "role_namespace": "kube-system",
          "is_default_template": false
        }
      ]
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 5
  }
}

    エラーコード

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

    変更履歴

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