All Products
Search
Document Center

Cloud Backup:AddContainerCluster

Last Updated:Mar 03, 2024

Registers a container cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
IdentifierstringYes

The ID of the cluster that you want to register.

cca8f35f0e0d84540b49d994511c2c87a
NamestringNo

The name of the cluster.

ack_pv_backup_location
DescriptionstringNo

The description of the cluster.

description ack pv backup
ClusterTypestringYes

The type of the cluster. Only Container Service for Kubernetes (ACK) clusters are supported.

ACK
NetworkTypestringYes

The network type of the cluster. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1FCBC078-FFCB-542A-8555-566477679720
Tokenstring

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

eyJhY2NvdW*****VnZpgXQC5A==
Successboolean

Indicates whether the request is successful.

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

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

200
Messagestring

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

successful
ClusterIdstring

The ID of the cluster.

cc-00049slr9iuvvv6pp134

Examples

Sample success responses

JSONformat

{
  "RequestId": "1FCBC078-FFCB-542A-8555-566477679720",
  "Token": "eyJhY2NvdW*****VnZpgXQC5A==",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "ClusterId": "cc-00049slr9iuvvv6pp134"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history