Enables or disables a plan for an AnalyticDB for PostgreSQL instance.
Operation description
You can call this operation to enable or disable a specified plan. The plan management feature is supported only for AnalyticDB for PostgreSQL instances in Serverless mode.
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
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 Resourcesis 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:SetDBInstancePlanStatus | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PlanId | string | Yes | The ID of the plan. Note
You can call the DescribeDBInstancePlans operation to query the details of plans, including plan IDs.
| 1234 |
| PlanStatus | string | Yes | Specifies whether to enable or disable the plan. Valid values:
| disable |
| 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
Examples
Sample success responses
JSONformat
{
"Status": "success",
"ErrorMessage": "****",
"PlanId": "1234",
"RequestId": "34b32a0a-08ef-4a87-b6be-cdd988888888"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2022-08-25 | Add Operation | see changesets |