EnableElasticPlan API for activating a scaling plan - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

For 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:EnableElasticPlan

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ElasticPlanName	string	Yes	The name of the scaling plan. Note To query scaling plan names, call the DescribeElasticPlans operation.	test
DBClusterId	string	Yes	The cluster ID. Note To query the IDs of all AnalyticDB for MySQL clusters in a region, call the DescribeDBClusters operation.	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.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.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.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.