All Products
Search
Document Center

AnalyticDB:ModifyAccountDescription

Last Updated:Nov 04, 2024
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Modifies the description of a database account for an AnalyticDB for PostgreSQL instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:ModifyAccountDescriptionupdate
  • DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.
gp-bp12ga6v69h86****
AccountNamestringYes

The name of the database account.

testAccout
AccountDescriptionstringYes

The new description of the database account.

  • The description must start with a letter.
  • The description cannot start with http:// or https://.
  • The description can contain letters, underscores (_), hyphens (-), and digits.
  • The description must be 2 to 256 characters in length.
testAccoutdescribe
ClientTokenstringNo

Idempotence check. For more information, see How to Ensure Idempotence.

0c593ea1-3bea-11e9-b96b-88**********

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2

Examples

Sample success responses

JSONformat

{
  "RequestId": "99BBBD5E-B5D8-4FC8-B8BF-FB1A0A38BBA2"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-11The internal configuration of the API is changed, but the call is not affectedView Change Details