You can call this opeation to modify the description of an AnalyticDB for MySQL cluster to facilitate the cluster maintenance and management.

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
Action String Yes ModifyDBClusterDescription

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

ModifyDBClusterDescription.
DBClusterDescription String Yes Clusters in Alibaba Cloud test environment

The description of the cluster.

  • The description cannot start with http:// or https://.
  • The description must be 2 to 256 characters in length.
DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

Response parameters

Parameter Type Example Description
RequestId String 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ModifyDBClusterDescription
&DBInstanceDescription=Instance in Alibaba Cloud test environment
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format 

<RequestId>17F57FEE-EA4F-4337-8D2E-9C23CAA63D74</RequestId>

JSON format 

{
    "RequestId": "17F57FEE-EA4F-4337-8D2E-9C23CAA63D74"
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether you specify the cluster ID value correctly.

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