すべてのプロダクト
Search

このプロダクト

    :DescribeContainerCluster

    ドキュメントセンター

    :DescribeContainerCluster

    最終更新日:Dec 23, 2025

    指定された条件を満たす 1 つ以上のコンテナークラスターをクエリします。

    操作説明

    この操作を呼び出して、Container Service for Kubernetes (ACK) クラスターのみをクエリできます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:DescribeContainerCluster

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    返すページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効値：1～99。デフォルト値：10。

    10
    ClusterId

    string

    任意

    クラスター ID。

    cc-000*************hg9
    Identifier

    string

    任意

    コンテナークラスターの識別子。ACK クラスターの場合は、クラスター ID を指定します。

    cca*******************************87a

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
    Success

    boolean

    呼び出しが成功したかどうかを示します。有効な値：

    • true：呼び出しは成功です。

    • false：呼び出しは失敗です。

    true
    Code

    string

    HTTP ステータスコード。状態コード 200 は、呼び出しが成功したことを示します。

    200
    Message

    string

    返されるメッセージ。呼び出しが成功した場合、「successful」が返されます。呼び出しが失敗した場合は、エラーメッセージが返されます。

    successful
    PageSize

    integer

    各ページで返されるエントリ数。有効値：1～99。デフォルト値：10。

    100
    PageNumber

    integer

    返されたページのページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    TotalCount

    integer

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

    8
    Clusters

    array<object>

    クラスターの情報。

    object

    クラスターの情報。

    Token

    string

    クラスターに Hybrid Backup Recovery (HBR) クライアントを登録するために使用されるトークン。

    eyJhY2Nvd******A/VnZpgXQC5A==
    Description

    string

    説明。

    description ack pv backup
    ClusterType

    string

    クラスターのタイプ。有効値：ACK。ACK クラスターを示します。

    ACK
    Identifier

    string

    クラスターの識別子。

    c5bbd0931a30947f4ab85efd19380a72d
    NetworkType

    string

    クラスターのネットワークタイプ。有効な値：

    • CLASSIC：クラシックネットワーク

    • VPC：VPC

    VPC
    Name

    string

    インスタンスの名前。

    ack_pv_backup_location
    AgentStatus

    string

    クライアントの状態。有効な値：

    • MISS：クライアントは切断されています。

    • UNKNOWN：クライアントは不明な状態です。

    • READY：クライアントは準備完了です。

    READY
    ClusterId

    string

    クラスターの ID。

    cl-0006gwppd0jtttpmb0ri

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 100,
  "PageNumber": 1,
  "TotalCount": 8,
  "Clusters": [
    {
      "Token": "eyJhY2Nvd******A/VnZpgXQC5A==",
      "Description": "description ack pv backup",
      "ClusterType": "ACK",
      "Identifier": "c5bbd0931a30947f4ab85efd19380a72d",
      "NetworkType": "VPC",
      "Name": "ack_pv_backup_location",
      "AgentStatus": "READY",
      "ClusterId": "cl-0006gwppd0jtttpmb0ri"
    }
  ]
}

    エラーコード

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

    変更履歴

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