Call the CreateElasticPlan API to create a scaling plan - AnalyticDB - Alibaba Cloud - AnalyticDB

Creates a scaling plan for an AnalyticDB for MySQL cluster.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ElasticPlanName	string	Yes	The name of the scaling plan. Note The name must be 2 to 30 characters in length and can contain letters, digits, and underscores (_). The name must start with a letter.	test
ResourceGroupName	string	No	The name of the resource group. Note Required if the scaling plan uses interactive resource groups. Not required if the scaling plan uses elastic I/O units (EIUs). You can call the DescribeDBResourceGroup operation to query the resource group name for a cluster.	test
StartTime	string	No	The start time of the scaling plan. Note Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-01-01T12:01:00Z
EndTime	string	No	The end time of the scaling plan. Note Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2025-01-01T12:01:00Z
Enabled	boolean	Yes	Whether to enable the scaling plan immediately after it is created. Valid values: true false	true
CronExpression	string	No	A CRON expression that specifies the scaling cycle and time for the scaling plan.	0 20 14 * * ?
TargetSize	string	No	The desired specifications of elastic resources after scaling. Note Not required if the scaling plan uses EIUs with Default Proportional Scaling for EIUs enabled. Required in all other cases. You can call the DescribeElasticPlanSpecifications operation to query the specifications that are supported for scaling plans.	32ACU
Type	string	Yes	The type of the scaling plan. Valid values: EXECUTOR: the interactive resource group type, which indicates the computing resource type. WORKER: the EIU type.	EXECUTOR
AutoScale	boolean	No	Whether to enable Default Proportional Scaling for EIUs. Valid values: true. In this case, storage resources are scaled along with computing resources, and the TargetSize and CronExpression parameters are not supported. false Note Required when Type is set to WORKER. Not required when Type is set to EXECUTOR. You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster.	false
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****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A5C433C2-001F-58E3-99F5-3274C14DF8BD

Examples

Success response

JSON format

{
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ACS.ElasticPlan.InvalidEndTime	The end time should be later than current time.	The end time of scheduled scaling must be later than the current time.
400	ACS.ElasticPlan.NameAlreadyExists	The name already exists.	A scaling plan with the same name exists.
400	ACS.ElasticPlan.WorkerNotFound	Worker not found.	The cluster cannot have storage scaling plans configured because it does not have reserved storage resources.
400	ACS.ElasticPlan.AutoWorkerPlanExists	Failed to enable the elastic plan. The instance already has an active elastic plan.	Failed to enable the storage scaling plan because the cluster has another storage scaling plan enabled.
400	ACS.ElasticPlan.WorkerPlanExists	Failed to enable the elastic plan. At least one active elastic plan already exists.	Failed to enable the storage scaling plan because another storage scaling plan has been enabled.
400	ACS.ElasticPlan.InvalidStartTimeInterval	The start time of this elastic plan is too closed to another one.	The effective time of the scaling plan is close to that of another scaling plan.
400	ACS.ElasticPlan.InvalidTodayPlan	Failed to enable this elastic plan. Today's schedule time is missed and you should prepare at least %s minutes for us to prepare resource.
400	ACS.ElasticPlan.InvalidTargetSize	Invalid target size.
400	ACS.ElasticPlan.InvalidStartTime	Invalid start time.
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.