DescribeElasticPlans - AnalyticDB for MySQL - Alibaba Cloud ドキュメントセンター

Queries scaling plans of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ElasticPlanName	string	No	The name of the scaling plan. Note If you do not specify this parameter, all scaling plans are queried.	test
ResourceGroupName	string	No	The name of the resource group. Note If you do not specify this parameter, the scaling plans of all resource groups are queried, covering the interactive resource group type and the elastic I/O unit (EIU) type. You can call the DescribeDBResourceGroup operation to query the name of a resource group within a cluster.	test
Enabled	boolean	No	Indicates whether the scaling plan was immediately enabled after the plan is created. Valid values: true false	true
PageSize	integer	Yes	The number of entries per page.	10
PageNumber	integer	Yes	The page number.	1
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****
Type	string	No	The type of the scaling plan. Valid values: EXECUTOR: interactive resource groups, which fall into the computing resource category. WORKER: EIUs.	EXECUTOR

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	15
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
ElasticPlans	array<object>	The scaling plans.
	object
ElasticPlanName	string	The name of the scaling plan.	test
Type	string	The type of the scaling plan. Valid values: EXECUTOR: interactive resource group. WORKER: EIU.	EXECUTOR
Enabled	boolean	Indicates whether the scaling plan was immediately enabled after the plan is created. Valid values: true false	true
ResourceGroupName	string	The name of the resource group. Note You can call the DescribeDBResourceGroup operation to query the name of a resource group within a cluster.	test
TargetSize	string	The amount of elastic resources after scaling.	32ACU
NextScheduleTime	string	The time when the next scheduling is performed. Note The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2022-01-01T12:01:00Z
AutoScale	boolean	Indicates whether Proportional Default Scaling for EIUs is enabled. Valid values: true false	false
RequestId	string	The request ID.	A5C433C2-001F-58E3-99F5-3274C14DF8BD

Examples

Sample success responses

JSONformat

{
  "TotalCount": 15,
  "PageNumber": 1,
  "PageSize": 10,
  "ElasticPlans": [
    {
      "ElasticPlanName": "test",
      "Type": "EXECUTOR",
      "Enabled": true,
      "ResourceGroupName": "test",
      "TargetSize": "32ACU",
      "NextScheduleTime": "2022-01-01T12:01:00Z",
      "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.

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

Change history

Change time	Summary of changes	Operation
2023-11-13	The Error code has changed	View Change Details
2023-06-02	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-04-13	The Error code has changed	View Change Details