Use UpdateContainerCluster to update container cluster information - 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:UpdateContainerCluster

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	Cluster ID.	cc-000**************134
Name	string	No	Cluster name.	ack_pv_backup_location
Description	string	No	Cluster description.	description ack pv backup
NetworkType	string	No	Network type. Valid values: CLASSIC: classic network. VPC: Virtual Private Cloud (VPC).	VPC
RenewToken	boolean	No	Whether to regenerate the token.	false

Response elements

Element	Type	Description	Example
	object
TokenUpdated	boolean	Indicates whether the cluster token has been updated.	false
RequestId	string	Request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Token	string	Cluster token, used for registering HBR clients within the cluster.	eyJhY2NvdW*****VnZpgXQC5A==
Success	boolean	Indicates whether the request was successful. true: Success false: Failure	true
Code	string	The return code. A value of 200 indicates success.	200
Message	string	The response message.	successful

Examples

Success response

JSON format

{
  "TokenUpdated": false,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Token": "eyJhY2NvdW*****VnZpgXQC5A==",
  "Success": true,
  "Code": "200",
  "Message": "successful"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.