DescribeElasticPlans - AnalyticDB - Alibaba Cloud Documentation Center

Queries scaling plans of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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
adb:DescribeElasticPlans	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ElasticPlanName	string	No	The name of the scaling plan. Note If you do not specify this parameter, all scaling plans are queried.	test
ResourceGroupName	string	No	The name of the resource group. Note If you do not specify this parameter, the scaling plans of all resource groups are queried, covering the interactive resource group type and the elastic I/O unit (EIU) type. You can call the DescribeDBResourceGroup operation to query the name of a resource group within a cluster.	test
Enabled	boolean	No	Specifies whether to query the scaling plans that are immediately enabled after the plans are created. Valid values: true false	true
PageSize	integer	Yes	The number of entries per page.	10
PageNumber	integer	Yes	The page number.	1
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.	amv-wz9509beptiz****
Type	string	No	The type of the scaling plan. Valid values: EXECUTOR: the interactive resource group type, which specifies the computing resource type. WORKER: the EIU type.	EXECUTOR

Response parameters

Parameter	Type	Description	Example
	object	PaginationResponse<List>
TotalCount	integer	The total number of entries returned.	15
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
ElasticPlans	array<object>	The queried scaling plans.
	object	The queried scaling plan.
ElasticPlanName	string	The name of the scaling plan.	test
Type	string	The type of the scaling plan. Valid values: EXECUTOR: the interactive resource group type, which specifies the computing resource type. WORKER: the EIU type.	EXECUTOR
Enabled	boolean	Indicates whether the scaling plan is immediately enabled after the plan is created. Valid values: true false	true
ResourceGroupName	string	The name of the resource group. Note You can call the DescribeDBResourceGroup operation to query the name of a resource group within a cluster.	test
TargetSize	string	The amount of elastic resources after scaling.	32ACU
NextScheduleTime	string	The time when the next scheduling is performed. Note The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2022-01-01T12:01:00Z
AutoScale	boolean	Indicates whether Proportional Default Scaling for EIUs is enabled. Valid values: true false	false
RequestId	string	The request ID.	A5C433C2-001F-58E3-99F5-3274C14DF8BD

Examples

Sample success responses

JSONformat

{
  "TotalCount": 15,
  "PageNumber": 1,
  "PageSize": 10,
  "ElasticPlans": [
    {
      "ElasticPlanName": "test",
      "Type": "EXECUTOR",
      "Enabled": true,
      "ResourceGroupName": "test",
      "TargetSize": "32ACU",
      "NextScheduleTime": "2022-01-01T12:01:00Z",
      "AutoScale": false
    }
  ],
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Change history

Change time	Summary of changes	Operation
2023-11-13	The Error code has changed	View Change Details
2023-06-02	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-04-13	The Error code has changed	View Change Details