RotateClusterManagedCert - Key Management Service - Alibaba Cloud Documentation Center

Operation description

This operation is available only for certificate hosting clusters in regions within the China site (aliyun.com).

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

yundun-hsm:RotateClusterManagedCert

update

*All Resource

*

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	cluster-hfau****gkaud

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	4C467B38-3910-447D-87BC-AC049166F216
Job	object	The details of the task.
JobId	string	The task ID.	job-202401250936hze747fd7e0007005
Type	string	The operation type of the task. create: Creates a task. cancel: Cancels a task.	create
Completed	boolean	Indicates whether the task is complete. true: The task is complete. false: The task is in progress.	true
CreateTime	string	The time when the task was created. This value is a UNIX timestamp in milliseconds.	1653274407000
Status	string	The status of the task. success: The task is successful. running: The task is in progress. cancel: The task is canceled. fail: The task failed.	running
Response	string	The response returned after the task is successful.	success
Error	string	The error message returned if the task failed.	OperationTimeout
Process	integer	The progress of the task in percent.	100

Examples

Success response

JSON format

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "Job": {
    "JobId": "job-202401250936hze747fd7e0007005",
    "Type": "create",
    "Completed": true,
    "CreateTime": "1653274407000",
    "Status": "running",
    "Response": "success",
    "Error": "OperationTimeout",
    "Process": 100
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Cluster.ClusterManagedCertRotate.NotSupport	rotate cluster managed cert not support
500	InternalError	The request processing has failed due to some unknown error.	Unknown error caused request processing to fail.
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.