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

Creates a time-based elastic plan. This operation applies only to Data Warehouse Edition clusters in elastic mode (new version).

Operation description

Usage notes

This operation applies only to Data Warehouse Edition clusters in elastic mode (new version) with 32 or more cores.

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 Data Warehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all Data Warehouse Edition clusters in the specified region.	am-bp1d8lbdj22rx****
ElasticPlanName	string	Yes	The name of the elastic plan. Valid values: The name must be 2 to 30 characters in length. The name can contain uppercase letters, lowercase letters, digits, and underscores (_).	test
ResourcePoolName	string	No	The name of the resource group. Note You can call the DescribeDBResourceGroup operation to query the name of the resource group.	realtime
ElasticPlanNodeNum	integer	No	The number of nodes in the elastic plan. If ElasticPlanType is set to worker, you can leave this parameter empty or set it to 0. If ElasticPlanType is set to executorcombineworker or executor, you must set this parameter to a value greater than 0.	0
ElasticPlanTimeStart	string	Yes	The start time of the scale-out for the elastic plan. Only time frame settings are supported. Format: HH:mm:ss.	08:00:00
ElasticPlanTimeEnd	string	Yes	The revert time of the elastic plan. Only time frame settings are supported. The interval between the scale-out time and the revert time cannot exceed 24 hours. Format: HH:mm:ss.	10:00:00
ElasticPlanWeeklyRepeat	string	No	The weekly recurrence of the elastic plan. Valid values: 0 to 6, which represent Sunday to Saturday. Separate multiple days with commas (,).	1,2,3,4,5
ElasticPlanMonthlyRepeat	string	No	The monthly recurrence of the elastic plan. The value represents the day of the month. Separate multiple days with commas (,).	1,15,25
ElasticPlanStartDay	string	No	The start date of the elastic plan. Format: yyyy-MM-dd.	2022-12-02
ElasticPlanEndDay	string	No	The end date of the elastic plan. Format: yyyy-MM-dd.	2022-12-09
ElasticPlanEnable	boolean	No	Specifies whether the elastic plan takes effect. Valid values: true (default): The elastic plan takes effect. false: The elastic plan does not take effect.	true
ElasticPlanType	string	No	The resource type of the elastic plan. Valid values: worker: Independent scaling of elastic I/O resources. executor: Independent scaling of compute resources. executorcombineworker (default): Joint scaling of compute and elastic I/O resources at the default ratio. Note To use executorcombineworker, the cluster Milvus version must be 3.1.3.2 or later. To use worker or executor, the cluster Milvus version must be 3.1.6.1 or later, and you must submit a ticket to apply for the feature. You can use worker or executor only after the application is approved.	worker
ElasticPlanWorkerSpec	string	No	The resource specification supported for scale-out in the elastic plan. Valid values: 8 cores, 64 GB (default) 16 cores, 64 GB 32 cores, 64 GB 64 cores, 128 GB 12 cores, 96 GB 24 cores, 96 GB 52 cores, 86 GB	32 Core 64 GB

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The ID of the request.	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 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.