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

Queries the details of the elastic plan for a cluster.

Operation description

For the service registration address of the current service, 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 elastic plan. Note Call the DescribeElasticPlans operation to query the name of the elastic plan for the cluster.	test
DBClusterId	string	Yes	The ID of the cluster. Note Call the DescribeDBClusters operation to query the cluster ID.	amv-wz9509beptiz****

Response elements

Element	Type	Description	Example
	object	PlainResponse
ElasticPlan	object	The elastic plan.
ElasticPlanName	string	The name of the elastic plan.	test
Type	string	The type of the elastic plan.	EXECUTOR
Enabled	boolean	Indicates whether the elastic plan is enabled.	true
ResourceGroupName	string	The name of the resource group to which the elastic plan belongs.	test
TargetSize	string	The target specifications.	32ACU
StartTime	string	The start time. Note The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2022-01-01T12:01:00Z
EndTime	string	The end time. Note The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2025-01-01T12:01:00Z
CronExpression	string	The cron expression, which indicates the scaling cycle and scaling time of the elastic plan.	0 20 14 * * ?
AutoScale	boolean	Indicates whether proportional default elastic scaling for the storage acceleration service (EIU) is enabled. Valid values: true: Enabled. After this feature is enabled, storage resources scale in or out along with the elastic scaling of compute resources. false: Disabled. Note Only one storage elastic plan with proportional default elastic scaling for the storage acceleration service (EIU) can be enabled for the entire cluster. After this type of elastic plan is enabled, no other storage elastic plans can be enabled.	false
RequestId	string	The ID of the request.	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.