PauseInstance - AnalyticDB - Alibaba Cloud Documentation Center

Pauses an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to pause an AnalyticDB for PostgreSQL instance that is in the Running state.

This operation is available only for AnalyticDB for PostgreSQL instances in Serverless mode that run V1.0.2.1 or later. For more information about how to view and update the minor engine version of an instance, see View the minor engine version and Update the minor engine version.

Note Before you call this operation, make sure that you are familiar with the billing methods and pricing of AnalyticDB for PostgreSQL instances. For more information, see Billing methods and AnalyticDB for PostgreSQL pricing.

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

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:PauseInstance	get	DBInstance `acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.	gp-bp12ga6v69h86****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	34b32a0a-08ef-4a87-b6be-cdd9********
Status	boolean	Indicates whether the request was successful. Valid values: false: The request failed. true: The request was successful.	true
ErrorMessage	string	The error message returned. This parameter is returned only if false is returned for the Status parameter.	*******
DBInstanceId	string	The ID of the instance.	gp-bp12ga6v69h86****

Examples

Sample success responses

JSONformat

{
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd9********",
  "Status": true,
  "ErrorMessage": "*******",
  "DBInstanceId": "gp-bp12ga6v69h86****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history