Modifies the description of an AnalyticDB for MySQL cluster to facilitate the maintenance and management of the cluster.

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.

DBClusterId String Yes am-bp11q28kvl688****

The ID of the cluster.

DBClusterDescription String Yes adb_test

The description of the cluster.

  • The description cannot start with http:// or https.
  • The description must be 2 to 256 characters in length.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=ModifyDBClusterDescription
&DBClusterId=am-bp11q28kvl688****
&DBClusterDescription=adb_test
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether the cluster ID is valid.

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