All Products
Search
Document Center

PolarDB:ModifyDBDescriptionZonal

Last Updated:Oct 15, 2025

Modifies the description of a database in a PolarDB for Cloud Edge cluster.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
DBClusterId

string

Yes

The ID of the cluster.

pc-**************
DBName

string

Yes

The name of the database.

testDB
DBDescription

string

Yes

The description of the database. The description must meet the following requirements:

  • It cannot start with http:// or https://.

  • It must be 2 to 256 characters in length.

testdesc
ClientToken

string

No

A client-generated token that ensures the idempotence of the request. The token must be unique for each request. It is case-sensitive and must not exceed 64 ASCII characters.

6000170000591aed949d0f54a343f1a4233c1e7d1c5******

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The ID of the request.

EB07CFF0-D8A4-5C76-AED7-D00E26FC2***

Examples

Success response

JSON format

{ "RequestId": "EB07CFF0-D8A4-5C76-AED7-D00E26FC2***" }

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidAccountName.Malformed The specified parameter AccountName is not valid. The specified AccountName parameter is invalid.
400 InvalidDBDescription.Malformed The specified parameter DBDescription is not valid. The specified DBDescription parameter is invalid.
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.
404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.