全部產品
Search
文件中心

Cloud Backup:DescribeContainerCluster - 查詢容器叢集

更新時間:Dec 23, 2025

查詢合格一個或多個容器叢集。

介面說明

僅用於阿里雲Container Service Kubernetes 版整合使用。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

PageNumber

integer

分頁頁碼,從 1 開始,預設值為 1。

1

PageSize

integer

分頁大小,最小值為 1,最大值為 99,預設值為 10。

10

ClusterId

string

叢集 ID。

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

Identifier

string

容器叢集標識符,對於阿里雲Container Service Kubernetes 叢集,該參數指 Kubernetes 叢集 ID。

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

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2

Success

boolean

請求是否成功。

  • true:成功

  • false:失敗

true

Code

string

返回碼。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

叢集 token,用於叢集中 hbr 用戶端註冊使用。

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

Description

string

描述資訊。

description ack pv backup

ClusterType

string

叢集類型,僅支援 ACK,表示阿里雲Container Service Kubernetes 版中的容器叢集。

ACK

Identifier

string

叢集標識。

c5bbd0931a30947f4ab85efd19380a72d

NetworkType

string

網路類型,傳回值包括:

  • CLASSIC:傳統網路。

  • VPC:專用網路。

VPC

Name

string

叢集名稱。

ack_pv_backup_location

AgentStatus

string

用戶端狀態:

  • MISS:失聯。

  • UNKNOWN:未知。

  • READY:就緒。

READY

ClusterId

string

叢集 ID。

cl-0006gwppd0jtttpmb0ri

樣本

正常返回樣本

JSON格式

{
  "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"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情