Query scaling plan attributes with DescribeElasticPlanAttribute - AnalyticDB - Alibaba Cloud - AnalyticDB

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ElasticPlanName	string	Yes	The name of the scaling plan. Note You can call the DescribeElasticPlans operation to query the names of scaling plans.	test
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.
ElasticPlan	object	The queried scaling plan.
ElasticPlanName	string	The name of the scaling plan.	test
Type	string	The type of the scaling plan.	EXECUTOR
Enabled	boolean	Indicates whether the scaling plan is enabled.	true
ResourceGroupName	string	The name of the resource group used by the scaling plan.	test
TargetSize	string	The amount of elastic resources after scaling.	32ACU
StartTime	string	The start time of the scaling plan. Note The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2022-01-01T12:01:00Z
EndTime	string	The end time of the scaling plan. Note The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2025-01-01T12:01:00Z
CronExpression	string	A CORN expression that indicates the scaling cycle and time for the scaling plan.	0 20 14 * * ?
AutoScale	boolean	Indicates whether Default Proportional Scaling for EIUs is enabled. Valid values: true: Default Proportional Scaling for EIUs is enabled. If you set this parameter to true, storage resources are scaled along with computing resources. false: Default Proportional Scaling for EIUs is not enabled. Note You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster. After you enable a scaling plan of the Default Proportional Scaling for EIUs type, you cannot enable scaling plans of other types.	false
RequestId	string	The request ID.	A5C433C2-001F-58E3-99F5-3274C14DF8BD

Examples

Success response

JSON format

{
  "ElasticPlan": {
    "ElasticPlanName": "test",
    "Type": "EXECUTOR",
    "Enabled": true,
    "ResourceGroupName": "test",
    "TargetSize": "32ACU",
    "StartTime": "2022-01-01T12:01:00Z",
    "EndTime": "2025-01-01T12:01:00Z",
    "CronExpression": "0 20 14 * * ?",
    "AutoScale": false
  },
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

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.
404	ACS.ElasticPlan.NotFound	The elastic plan is not found.	The elastic plan is not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.