All Products
Search
Document Center

Hybrid Backup Recovery:DescribeContainerCluster

Last Updated:Nov 14, 2022

Queries one or more container cluster that meet the specified conditions.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

10
ClusterIdstringNo

The cluster id.

cc-0007xt00u1q2lownbhg9

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
PageSizeinteger

The number of entries returned per page. Valid values: 1 to 99. Default value: 10.

100
PageNumberinteger

The page number of the returned page. Pages start from page 1. Default value: 1.

1
TotalCountlong

The total number of returned container cluster that meet the specified conditions.

8
Clustersarray

The clusters.

object
Tokenstring

The Token.

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

The description of container cluster.

description ack pv backup
ClusterTypestring

Cluster type, which only supports ACK, that indicates Alibaba Cloud Container Service.

ACK
Identifierstring

Cluster ID.

c5bbd0931a30947f4ab85efd19380a72d
NetworkTypestring

Network type, values includes:

  • CLASSIC: classic network.
  • VPC: virtual private cloud.
VPC
Namestring

Cluster name.

ack_pv_backup_location
AgentStatusstring

Agent status.

READY
ClusterIdstring

The cluster id.

cl-0006gwppd0jtttpmb0ri

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.