DescribeElasticPlanAttribute - AnalyticDB - Alibaba Cloud ドキュメントセンター

Queries the information about a scaling plan for an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeElasticPlanAttribute	list	All Resources *	none	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 Data Lakehouse Edition (V3.0) clusters within a region.	amv-wz9509beptiz****

Response parameters

Parameter	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-12	The Error code has changed	View Change Details
2023-10-23	The Error code has changed	View Change Details
2023-04-13	The Error code has changed	View Change Details