All Products
Search
Document Center

AnalyticDB for MySQL:DescribeElasticPlan

Last Updated:Mar 15, 2024

Queries scaling plans of an AnalyticDB for MySQL cluster. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.

Operation description

You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition that have 32 cores or more.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeElasticPlanRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
am-bp278jg9****
ElasticPlanNamestringNo

The name of the scaling plan.

  • The name must be 2 to 30 characters in length.
  • The name can contain letters, digits, and underscores (_).
Note If you do not specify this parameter, the information about all scaling plans for the specified cluster is returned.
realtime
ResourcePoolNamestringNo

The name of the resource group.

Note You can call the DescribeDBResourceGroup operation to query the resource group name.
USER_DEFAULT
ElasticPlanEnablebooleanNo

Specifies whether the scaling plan takes effect. Valid values:

  • true (default)
  • false
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticPlanListobject []

The queried scaling plans.

EndTimestring

The restoration time of the scaling plan. The interval between the scale-up time and the restoration time cannot be more than 24 hours. The time is in the HH:mm:ss format.

10:00:00
WeeklyRepeatstring

The days of the week when the scaling plan was executed. Valid values: 0 to 6, which indicate Sunday to Saturday. Multiple values are separated by commas (,).

3,4,5,6
MonthlyRepeatstring

The days of the month when the scaling plan was executed. A value indicates a day of the month. Multiple values are separated by commas (,).

1,15,25
StartTimestring

The scale-up time of the scaling plan. The time is in the HH:mm:ss format.

08:00:00
ResourcePoolNamestring

The name of the resource group.

USER_DEFAULT
StartDaystring

The start date of the scaling plan. This parameter is returned only if the start date of the scaling plan is set. The date is in the yyyy-MM-dd format.

2022-12-02
ElasticNodeNuminteger

The number of nodes that are involved in the scaling plan.

  • If ElasticPlanType is set to worker, a value of 0 or null is returned.
  • If ElasticPlanType is set to executorcombineworker or executor, a value greater than 0 is returned.
0
Enableboolean

Indicates whether the scaling plan takes effect. Valid values:

  • true (default)
  • false
true
EndDaystring

The end date of the scaling plan. This parameter is returned only if the end date of the scaling plan is set. The date is in the yyyy-MM-dd format.

2022-12-09
PlanNamestring

The name of the scaling plan.

realtime
ElasticPlanTypestring

The type of the scaling plan. Valid values:

  • worker: scales only elastic I/O resources.
  • executor: scales only computing resources.
  • executorcombineworker (default): scales both elastic I/O resources and computing resources by proportion.
worker
ElasticPlanWorkerSpecstring

The resource specifications that can be scaled up by the scaling plan. Valid values:

  • 8 Core 64 GB (default)
  • 16 Core 64 GB
  • 32 Core 64 GB
  • 64 Core 128 GB
  • 12 Core 96 GB
  • 24 Core 96 GB
  • 52 Core 86 GB
16 Core 64 GB

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ElasticPlanList": [
    {
      "EndTime": "10:00:00",
      "WeeklyRepeat": "3,4,5,6",
      "MonthlyRepeat": "1,15,25",
      "StartTime": "08:00:00",
      "ResourcePoolName": "USER_DEFAULT",
      "StartDay": "2022-12-02",
      "ElasticNodeNum": 0,
      "Enable": true,
      "EndDay": "2022-12-09",
      "PlanName": "realtime",
      "ElasticPlanType": "worker",
      "ElasticPlanWorkerSpec": "16 Core 64 GB"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
2023-12-27The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.