DescribeElasticPlanSpecifications - AnalyticDB for MySQL API - AnalyticDB

Operation description

Supported service endpoints are listed in 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:DescribeElasticPlanSpecifications

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The type of the scaling plan. Valid values: EXECUTOR: computing resources for interactive resource groups. WORKER: the elastic I/O unit (EIU) type.	EXECUTOR
ResourceGroupName	string	No	The name of the resource group. Note Required only when querying specifications for an interactive resource group. Call DescribeDBResourceGroup to query resource group names in a cluster.	test
DBClusterId	string	Yes	The cluster ID. Note Call DescribeDBClusters to query cluster IDs in a region.	amv-wz9509beptiz****

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	5
Specifications	array	The queried resource specifications.
	string	The queried resource specification.	16ACU
RequestId	string	The request ID.	A5C433C2-001F-58E3-99F5-3274C14DF8BD

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 5,
  "Specifications": [
    "16ACU"
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.