All Products
Search
Document Center

AnalyticDB:DescribeElasticPlanSpecifications

Last Updated:Aug 30, 2024

Queries the resource specifications that are supported by different types of scaling plans of 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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringYes

The type of the scaling plan. Valid values:

  • EXECUTOR: the interactive resource group type, which specifies the computing resource type.
  • WORKER: the elastic I/O unit (EIU) type.
EXECUTOR
ResourceGroupNamestringNo

The name of the resource group.

Note
  • This parameter must be specified only when you query the resource specifications that are supported by an interactive resource group.

  • You can call the DescribeDBResourceGroup operation to query the name of a resource group within a cluster.

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of entries returned.

10
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

5
Specificationsarray

The queried resource specifications.

string

The queried resource specification.

16ACU
RequestIdstring

The request ID.

A5C433C2-001F-58E3-99F5-3274C14DF8BD

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 5,
  "Specifications": [
    "16ACU"
  ],
  "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-12-12The Error code has changedView Change Details
2023-04-13The Error code has changedView Change Details