All Products
Search
Document Center

Cloud Backup:DescribeContainerCluster

Last Updated:Dec 19, 2024

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

Operation description

You can call this operation to query only Container Service for Kubernetes (ACK) clusters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hbr:DescribeContainerClusterget
*All Resources
*
    none
none

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-000*************hg9
IdentifierstringNo

The identifier of the container cluster. For a Container Service for Kubernetes (ACK) cluster, specify the cluster ID.

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
Successboolean

Indicates whether the call is successful. Valid values:

  • 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 on each 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 entries.

8
Clustersarray<object>

The information of clusters.

Clusterobject

The information of clusters.

Tokenstring

The token that is used to register the Hybrid Backup Recovery (HBR) client in the cluster.

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

The description.

description ack pv backup
ClusterTypestring

The type of the cluster. Valid value: ACK, which indicates ACK clusters.

ACK
Identifierstring

The identifier of the cluster.

c5bbd0931a30947f4ab85efd19380a72d
NetworkTypestring

The network type of the cluster. Valid values:

  • CLASSIC: the classic network
  • VPC: virtual private cloud (VPC)
VPC
Namestring

The name of the instance.

ack_pv_backup_location
AgentStatusstring

The status of the client. Valid values:

  • MISS: The client is disconnected.
  • UNKNOWN: The client is in an unknown state.
  • READY: The client is ready.
READY
ClusterIdstring

The ID of the cluster.

cl-0006gwppd0jtttpmb0ri

Examples

Sample success responses

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 Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-21The request parameters of the API has changedView Change Details