Use AddContainerCluster API to Back Up ACK Clusters - Cloud Backup - Alibaba Cloud - Cloud Backup

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:AddContainerCluster

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	Yes	The ID of the cluster that you want to register.	cca8f35f0e0d84540b49d994511c2c87a
Name	string	No	The name of the cluster.	ack_pv_backup_location
Description	string	No	The description of the cluster.	description ack pv backup
ClusterType	string	Yes	The type of the cluster. Only Container Service for Kubernetes (ACK) clusters are supported.	ACK
NetworkType	string	Yes	The network type of the cluster. Valid values: CLASSIC: the classic network VPC: a virtual private cloud (VPC)	VPC

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	1FCBC078-FFCB-542A-8555-566477679720
Token	string	The token that is used to register the Hybrid Backup Recovery (HBR) client in the cluster.	eyJhY2NvdW*****VnZpgXQC5A==
Success	boolean	Indicates whether the request is successful. true: The request is successful. false: The request fails.	true
Code	string	The HTTP status code. The status code 200 indicates that the request is successful.	200
Message	string	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
ClusterId	string	The ID of the cluster.	cc-00049slr9iuvvv6pp134

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.