CreateElasticPlan - Create scaling plan | AnalyticDB for MySQL API - AnalyticDB

Creates a scheduled scaling plan for AnalyticDB for MySQL 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:CreateElasticPlan

create

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 Call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.	am-bp1d8lbdj22rx****
ElasticPlanName	string	Yes	The name of the scaling plan. The name must be 2 to 30 characters in length. The name can contain letters, digits, and underscores (_).	test
ResourcePoolName	string	No	The name of the resource group. Note Call the DescribeDBResourceGroup operation to query resource group names.	realtime
ElasticPlanNodeNum	integer	No	The number of nodes in the scaling plan. If ElasticPlanType is set to worker, set this parameter to 0 or leave it empty. If ElasticPlanType is set to executorcombineworker or executor, set this parameter to a value greater than 0.	0
ElasticPlanTimeStart	string	Yes	The scale-up time of the scaling plan in HH:mm:ss format. The value must be on the hour.	08:00:00
ElasticPlanTimeEnd	string	Yes	The restoration time of the scaling plan in HH:mm:ss format. The value must be on the hour. The interval between scale-up and restoration cannot exceed 24 hours.	10:00:00
ElasticPlanWeeklyRepeat	string	No	The days of the week to run the scaling plan. Valid values: 0 to 6 (Sunday to Saturday). Separate multiple values with commas (,).	1,2,3,4,5
ElasticPlanMonthlyRepeat	string	No	The dates of the month to run the scaling plan. Each number specifies a day. Separate multiple values with commas (,).	1,15,25
ElasticPlanStartDay	string	No	The start date of the scaling plan in yyyy-MM-dd format.	2022-12-02
ElasticPlanEndDay	string	No	The end date of the scaling plan in yyyy-MM-dd format.	2022-12-09
ElasticPlanEnable	boolean	No	Specifies whether to enable the scaling plan. Valid values: true (default) false	true
ElasticPlanType	string	No	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. Note To use executorcombineworker, the cluster must run minor version 3.1.3.2 or later. To use worker or executor, the cluster must run minor version 3.1.6.1 or later. Submit a ticket to request approval before using these values.	worker
ElasticPlanWorkerSpec	string	No	The resource specifications for scaling. 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	32 Core 64 GB

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

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 does not exist. Verify that the value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.