You can call this operation to modify the description of a specified ApsaraDB for PolarDB cluster to facilitate cluster maintenance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
DBClusterDescription String Yes ClusterDescriptionTest

The name of the cluster.

  • It must start with a letter.
  • It can contain digits and special characters.
  • It cannot start with http:// or https.
  • It must be 2 to 256 characters in length.
DBClusterId String Yes pc-xxxxxxxxxxxxxxxxx

The ID of the cluster.

AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No ModifyDBClusterDescription

The operation that you want to perform. Set the value to ModifyDBClusterDescription.

Response parameters

Parameter Type Example Description
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=ModifyDBClusterDescription
&DBClusterDescription=ClusterDescriptionTest
&DBClusterId=pc-xxxxxxxxxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<ModifyDBClusterDescriptionResponse>  
	  <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</ModifyDBClusterDescriptionResponse>

JSON format

{
	"RequestId":"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

Error codes

For a list of error codes, visit the API Error Center.