All Products
Search

This Product

    AnalyticDB for MySQL:DescribeElasticPlans

    Document Center

    AnalyticDB for MySQL:DescribeElasticPlans

    Last Updated:Apr 12, 2024

    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.

    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:DescribeElasticPlansList
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ElasticPlanNamestringNo

    The name of the scaling plan.

    Note If you do not specify this parameter, all scaling plans are queried.
    		test
    ResourceGroupNamestringNo

    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
    EnabledbooleanNo

    Indicates whether the scaling plan was immediately enabled after the plan is created. Valid values:

    • true
    • false
    		true
    PageSizeintegerYes

    The number of entries per page.

    		10
    PageNumberintegerYes

    The page number.

    		1
    DBClusterIdstringYes

    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****
    TypestringNo

    The type of the scaling plan. Valid values:

    • EXECUTOR: interactive resource groups, which fall into the computing resource category.
    • WORKER: EIUs.
    		EXECUTOR

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    TotalCountinteger

    The total number of entries returned.

    		15
    PageNumberinteger

    The page number.

    		1
    PageSizeinteger

    The number of entries per page.

    		10
    ElasticPlansobject []

    The scaling plans.

    ElasticPlanNamestring

    The name of the scaling plan.

    		test
    Typestring

    The type of the scaling plan. Valid values:

    • EXECUTOR: interactive resource group.
    • WORKER: EIU.
    		EXECUTOR
    Enabledboolean

    Indicates whether the scaling plan was immediately enabled after the plan is created. Valid values:

    • true
    • false
    		true
    ResourceGroupNamestring

    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
    TargetSizestring

    The amount of elastic resources after scaling.

    		32ACU
    NextScheduleTimestring

    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
    AutoScaleboolean

    Indicates whether Proportional Default Scaling for EIUs is enabled. Valid values:

    • true
    • false
    		false
    RequestIdstring

    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 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-11-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
    2023-06-02The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Type
    2023-04-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 404