DescribeDBInstancePlans - AnalyticDB for PostgreSQL - Alibaba Cloud Documentation Center

Queries the information about plans for an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to query the details of plans for an AnalyticDB for PostgreSQL instance 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDBInstancePlans	Read	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-bp12ga6v69h86****
PlanDesc	string	No	The description of the plan.	this is a test plan
PlanType	string	No	The type of the plan. Valid values: PauseResume: pauses and resumes an instance. Resize: scales an instance.	PauseResume
PlanScheduleType	string	No	The execution mode of the plan. Valid values: Postpone: The plan is executed later. Regular: The plan is executed periodically.	Regular
PlanId	string	No	The plan ID. Note You can call the DescribeDBInstancePlans operation to query the information about plans, including plan IDs.	1234
PlanCreateDate	string	No	The time used to filter plans. If you specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format, the plans created before this time are returned. The time must be in UTC. If you do not specify this parameter, all plans are returned.	2022-04-17T23:00Z

Response parameters

Parameter	Type	Description	Example
	object
Status	string	Indicates whether the request was successful. If the request was successful, success is returned. If the request failed, this parameter is not returned.	success
ErrorMessage	string	The error message. This parameter is returned only if the request fails.	****
RequestId	string	The request ID.	34b32a0a-08ef-4a87-b6be-cdd988888888
TotalRecordCount	integer	The total number of entries returned.	1
PageRecordCount	integer	The number of entries per page.	1
PageNumber	integer	The page number.	1
Items	object []	The instance ID.
PlanName	string	The name of the plan.	test-plan
PlanDesc	string	The description of the plan.	this is a test plan
PlanId	string	The ID of the plan.	1234
PlanStatus	string	The state of the plan. Valid values: active: The plan is running. cancel: The plan is canceled. deleted: The plan is deleted. finished: The plan execution is complete.	active
PlanType	string	The type of the plan. Valid values: PauseResume: pauses and resumes an instance. Resize: scales an instance.	PauseResume
PlanScheduleType	string	The execution mode of the plan. Valid values: Postpone: The plan is executed later. Regular: The plan is executed periodically.	Regular
PlanStartDate	string	The start time of the plan. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. Note This parameter is returned only for periodically executed plans.	2022-04-17T23:00Z
PlanEndDate	string	The end time of the plan. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. Note This parameter is returned only for periodically executed plans.	2023-04-17T23:00Z
PlanConfig	string	The execution information of the plan.	{"pause":{"planCronTime":"0 22 * * 5"},"resume":{"planCronTime":"0 23 * * 5"}}
DBInstanceId	string	The ID of the instance.	gp-bp12ga6v69h86****

Examples

Sample success responses

JSONformat

{
  "Status": "success",
  "ErrorMessage": "****",
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd988888888",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "PlanList": [
      {
        "PlanName": "test-plan",
        "PlanDesc": "this is a test plan",
        "PlanId": "1234",
        "PlanStatus": "active",
        "PlanType": "PauseResume",
        "PlanScheduleType": "Regular",
        "PlanStartDate": "2022-04-17T23:00Z",
        "PlanEndDate": "2023-04-17T23:00Z",
        "PlanConfig": "{\"pause\":{\"planCronTime\":\"0 22 * * 5\"},\"resume\":{\"planCronTime\":\"0 23 * * 5\"}}",
        "DBInstanceId": "gp-bp12ga6v69h86****"
      }
    ]
  }
}

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