Modifies the description of an AnalyticDB for PostgreSQL instance.

Description

To make it easy to identify AnalyticDB for PostgreSQL instances, you can call this operation to modify the description of instances.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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.

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see View basic information of a resource group.

DBInstanceId String Yes gp-bp12ga6v69h86****

The ID of the instance.

Note You can call the DescribeDBInstances operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.
DBInstanceDescription String Yes test

The description of the instance.

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

Response parameters

Parameter Type Example Description
RequestId String 107BE202-D1A2-479E-98E0-A8**********

The ID of the request.

Examples

Sample requests

http(s)://gpdb.aliyuncs.com/?Action=ModifyDBInstanceDescription
&DBInstanceId=gp-bp12ga6v69h86****
&DBInstanceDescription=test
&<Common request parameters>

Sample success responses

XML format

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

<ModifyDBInstanceDescriptionResponse>
    <RequestId>107BE202-D1A2-479E-98E0-A8**********</RequestId>
</ModifyDBInstanceDescriptionResponse>

JSON format

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

{
  "RequestId" : "107BE202-D1A2-479E-98E0-A8**********"
}

Error codes

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