Changes the description of a PolarDB-X instance.

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 ModifyDBInstanceDescription

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

RegionId String Yes cn-hangzhou

The region ID of the instance.

DBInstanceName String Yes pxc-hzjasd****

The ID of the instance.

DBInstanceDescription String Yes test

The new description of the instance.

Response parameters

Parameter Type Example Description
RequestId String FEA5DC20-6D8A-5979-97AA-FC57546ADC20

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyDBInstanceDescription
&RegionId=cn-hangzhou
&DBInstanceName=pxc-hzjasd****
&DBInstanceDescription=test
&<Common request parameters>

Sample success responses

XML format 

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

<ModifyDBInstanceDescriptionResponse>
    <RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
</ModifyDBInstanceDescriptionResponse>

JSON format 

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

{
  "RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20"
}

Error codes

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