Use DescribeElasticPlan to query elastic plans - AnalyticDB - Alibaba Cloud - AnalyticDB

Retrieves the scaling plans of an AnalyticDB for MySQL cluster. This operation applies only to clusters in elastic mode for Cluster Edition.

Operation description

This operation applies only to AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition with 32 cores or more.

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

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.	am-bp278jg9****
ElasticPlanName	string	No	The name of the scaling plan. The name must be 2 to 30 characters in length. The name can contain letters, digits, and underscores (_). Note If not specified, information about all scaling plans for the cluster is returned.	realtime
ResourcePoolName	string	No	The name of the resource group. Note You can call the DescribeDBResourceGroup operation to query the resource group name.	USER_DEFAULT
ElasticPlanEnable	boolean	No	Whether the scaling plan takes effect. Valid values: true (default) false	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticPlanList	array<object>	The queried scaling plans.
	object
EndTime	string	The restoration time of the scaling plan, in HH:mm:ss format. The interval between the scale-up time and the restoration time cannot exceed 24 hours.	10:00:00
WeeklyRepeat	string	The days of the week when the scaling plan was executed. Valid values: 0 to 6, indicating Sunday to Saturday. Separate multiple values with commas (,).	3,4,5,6
MonthlyRepeat	string	The days of the month when the scaling plan was executed. Separate multiple values with commas (,).	1,15,25
StartTime	string	The scale-up time of the scaling plan, in HH:mm:ss format.	08:00:00
ResourcePoolName	string	The name of the resource group.	USER_DEFAULT
StartDay	string	The start date of the scaling plan, in yyyy-MM-dd format. Returned only if a start date is configured.	2022-12-02
ElasticNodeNum	integer	The number of nodes involved in the scaling plan. If ElasticPlanType is set to worker, a value of 0 or null is returned. If ElasticPlanType is set to executorcombineworker or executor, a value greater than 0 is returned.	0
Enable	boolean	Whether the scaling plan takes effect. Valid values: true (default) false	true
EndDay	string	The end date of the scaling plan, in yyyy-MM-dd format. Returned only if an end date is configured.	2022-12-09
PlanName	string	The name of the scaling plan.	realtime
ElasticPlanType	string	The type of the scaling plan. Valid values: worker: scales only elastic I/O resources. executor: scales only computing resources. executorcombineworker (default): scales both elastic I/O resources and computing resources by proportion.	worker
ElasticPlanWorkerSpec	string	The resource specifications that can be scaled up by the scaling plan. Valid values: 8 Core 64 GB (default) 16 Core 64 GB 32 Core 64 GB 64 Core 128 GB 12 Core 96 GB 24 Core 96 GB 52 Core 86 GB	16 Core 64 GB

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ElasticPlanList": [
    {
      "EndTime": "10:00:00",
      "WeeklyRepeat": "3,4,5,6",
      "MonthlyRepeat": "1,15,25",
      "StartTime": "08:00:00",
      "ResourcePoolName": "USER_DEFAULT",
      "StartDay": "2022-12-02",
      "ElasticNodeNum": 0,
      "Enable": true,
      "EndDay": "2022-12-09",
      "PlanName": "realtime",
      "ElasticPlanType": "worker",
      "ElasticPlanWorkerSpec": "16 Core 64 GB"
    }
  ]
}

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.