Query scaling plans by using DescribeElasticPlans - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the scaling plans of an AnalyticDB for MySQL cluster based on specified filter conditions.

Operation description

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

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

adb:DescribeElasticPlans

list

*All Resource

*

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, scaling plans for all resource groups are returned, including both 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 only the scaling plans that are enabled upon creation. 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 elements

Element	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 was enabled upon creation. 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 target amount of elastic resources after scaling.	32ACU
NextScheduleTime	string	The next scheduled execution time. Note The time follows 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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.