Pause AnalyticDB for PostgreSQL Serverless Instances via PauseInstance API - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

Pauses 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, see View the minor engine version and Update the minor engine version.

Note

Before you call this operation, familiarize yourself with the billing and pricing of AnalyticDB for PostgreSQL. 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. Requests that exceed this limit are throttled, which may affect your workloads.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:PauseInstance

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

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 IDs of all AnalyticDB for PostgreSQL instances in a region.	gp-bp12ga6v69h86****

Response elements

Element	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 when Status is false.	*******
DBInstanceId	string	The ID of the instance.	gp-bp12ga6v69h86****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.