All Products
Search
Document Center

AnalyticDB:ModifyDBInstanceConfig

Last Updated:Dec 20, 2024

Changes the threshold of computing resources and the wait period of idle resources for an AnalyticDB for PostgreSQL instance in Serverless automatic scheduling mode.

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:ModifyDBInstanceConfigget
*DBInstance
acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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.

rg-bp67acfmxazb4p****
DBInstanceIdstringYes

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.
gp-bp12ga6v69h86****
DBInstanceDescriptionstringNo

The description of the instance.

gp-bp12ga6v69h86****
ServerlessResourceintegerNo

The threshold of computing resources. Valid values: 8 to 32. Unit: AnalyticDB Compute Units (ACUs).

32
IdleTimeintegerNo

The wait period for the instance that has no traffic to become idle. Minimum value: 60. Default value: 600. Unit: seconds.

600

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD
ErrorMessagestring

The error message returned if the operation fails.

'error message'
DbInstanceIdstring

The ID of the instance.

gp-bp12ga6v69h86****
Statusboolean

The state of the operation. Valid values:

  • 0: The operation failed.
  • 1: The operation is successful.
1

Examples

Sample success responses

JSONformat

{
  "RequestId": "34B32A0A-08EF-4A87-B6BE-CDD9F56FC3AD",
  "ErrorMessage": "'error message'",
  "DbInstanceId": "gp-bp12ga6v69h86****",
  "Status": true
}

Error codes

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