DescribeAvailableResource - Query available AnalyticDB for MySQL resources - AnalyticDB

Queries available cluster resources within the zones of a specified region.

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:DescribeAvailableResource

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note Call DescribeRegions to query the latest region list.	cn-hangzhou
ZoneId	string	No	The zone ID. Note Call DescribeRegions to query the latest zone list.	cn-hangzhou-k
ChargeType	string	No	The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
AcceptLanguage	string	No	The language of query results. Valid values: zh-CN (default): Chinese. en-US: English.	zh-CN
DBClusterVersion	string	No	The version of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.	3.0

Response elements

Element	Type	Description	Example
	object	The supported regions.
RegionId	string	The region ID.	cn-hangzhou
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
AvailableZoneList	array<object>	The supported zones.
	array<object>	The supported zones.
ZoneId	string	The zone ID.	cn-hangzhou-h
SupportedMode	array<object>	The supported modes.
	array<object>	The supported mode.
Mode	string	The supported mode. Valid values: flexible: elastic mode. reserver: reserved mode.	flexible
SupportedSerialList	array<object>	The supported editions.
	array<object>	The supported edition.
Serial	string	The supported edition. Valid values: basic: Basic Edition. cluster: Cluster Edition. mixed_storage: elastic mode for Cluster Edition.	mixed_storage
SupportedFlexibleResource	array<object>	The supported resources in elastic mode.
	array<object>	The supported resources in elastic mode.
StorageType	string	The disk storage type. Valid values: hdd ssd	hdd
SupportedComputeResource	array	The supported computing resources.
	string	The specifications of supported computing resources.	[ "8Core32GB", "16Core64GB", "16Core64GBNEW", "24Core96GBNEW", "32Core128GBNEW", "48Core192GBNEW", "64Core256GBNEW", "80Core320GBNEW", "96Core384GBNEW", "128Core512GBNEW", "160Core640GBNEW", "192Core768GBNEW", "224Core896GBNEW", "256Core1024GBNEW", "288Core1152GBNEW", "320Core1280GBNEW", "384Core1536GBNEW", "416Core1664GBNEW", "448Core1792GBNEW", "480Core1920GBNEW", "512Core2048GBNEW", "576Core2304GBNEW", "640Core2560GBNEW", "768Core3072GBNEW", "800Core3200GBNEW", "896Core3584GBNEW", "960Core3840GBNEW", "1024Core4096GBNEW", "1120Core4480GBNEW", "1280Core5120GBNEW", "1440Core5760GBNEW", "1600Core6400GBNEW", "1792Core7168GBNEW", "1920Core7680GBNEW", "2048Core8192GBNEW", "2400Core9600GBNEW", "2560Core10240GBNEW", "2880Core11520GBNEW", "3200Core12800GBNEW", "4800Core19200GBNEW", "5600Core22400GBNEW", "6400Core25600GBNEW", "8000Core32000GBNEW", "8800Core35200GBNEW", "9600Core38400GBNEW" ]
SupportedStorageResource	array	The supported storage resources.
	string	The supported storage resources.	None
SupportedElasticIOResource	object	The supported elastic I/O resources.
Step	string	The step size.	1
MinCount	string	The minimum amount of elastic I/O resources.	0
MaxCount	string	The maximum amount of elastic I/O resources.	200
SupportedInstanceClassList	array<object>	The supported resources in reserved mode.
	array<object>	The supported resources in reserved mode.
InstanceClass	string	The supported instance type.	C32
Tips	string	The description of the instance type.	C32
SupportedNodeCountList	array<object>	The supported compute nodes.
	array<object>	The supported compute nodes.
StorageSize	array	The supported storage capacity. Unit: GB.
	string	The supported storage capacity. Unit: GB.	100
NodeCount	object	The number of the supported compute nodes.
Step	string	The step size.	1
MinCount	string	The minimum number of compute nodes.	1
MaxCount	string	The maximum number of compute nodes.	200
SupportedExecutorList	array<object>	A reserved parameter.
	array<object>	A reserved parameter.
NodeCount	object	The information about the supported compute nodes.
Step	string	A reserved parameter.	None
MinCount	string	A reserved parameter.	None
MaxCount	string	A reserved parameter.	None
SupportedComputeResource	array	A reserved parameter.
	string	A reserved parameter.	None
SupportedStorageResource	array	A reserved parameter.
	string	A reserved parameter.	None
ZoneName	string	The name of the zone.	HangzhouzoneA

Examples

Success response

JSON format

{
  "RegionId": "cn-hangzhou",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "AvailableZoneList": [
    {
      "ZoneId": "cn-hangzhou-h",
      "SupportedMode": [
        {
          "Mode": "flexible",
          "SupportedSerialList": [
            {
              "Serial": "mixed_storage",
              "SupportedFlexibleResource": [
                {
                  "StorageType": "hdd",
                  "SupportedComputeResource": [
                    "[\n                    \"8Core32GB\",\n                    \"16Core64GB\",\n                    \"16Core64GBNEW\",\n                    \"24Core96GBNEW\",\n                    \"32Core128GBNEW\",\n                    \"48Core192GBNEW\",\n                    \"64Core256GBNEW\",\n                    \"80Core320GBNEW\",\n                    \"96Core384GBNEW\",\n                    \"128Core512GBNEW\",\n                    \"160Core640GBNEW\",\n                    \"192Core768GBNEW\",\n                    \"224Core896GBNEW\",\n                    \"256Core1024GBNEW\",\n                    \"288Core1152GBNEW\",\n                    \"320Core1280GBNEW\",\n                    \"384Core1536GBNEW\",\n                    \"416Core1664GBNEW\",\n                    \"448Core1792GBNEW\",\n                    \"480Core1920GBNEW\",\n                    \"512Core2048GBNEW\",\n                    \"576Core2304GBNEW\",\n                    \"640Core2560GBNEW\",\n                    \"768Core3072GBNEW\",\n                    \"800Core3200GBNEW\",\n                    \"896Core3584GBNEW\",\n                    \"960Core3840GBNEW\",\n                    \"1024Core4096GBNEW\",\n                    \"1120Core4480GBNEW\",\n                    \"1280Core5120GBNEW\",\n                    \"1440Core5760GBNEW\",\n                    \"1600Core6400GBNEW\",\n                    \"1792Core7168GBNEW\",\n                    \"1920Core7680GBNEW\",\n                    \"2048Core8192GBNEW\",\n                    \"2400Core9600GBNEW\",\n                    \"2560Core10240GBNEW\",\n                    \"2880Core11520GBNEW\",\n                    \"3200Core12800GBNEW\",\n                    \"4800Core19200GBNEW\",\n                    \"5600Core22400GBNEW\",\n                    \"6400Core25600GBNEW\",\n                    \"8000Core32000GBNEW\",\n                    \"8800Core35200GBNEW\",\n                    \"9600Core38400GBNEW\"\n                  ]"
                  ],
                  "SupportedStorageResource": [
                    "None"
                  ],
                  "SupportedElasticIOResource": {
                    "Step": "1",
                    "MinCount": "0",
                    "MaxCount": "200"
                  }
                }
              ],
              "SupportedInstanceClassList": [
                {
                  "InstanceClass": "C32",
                  "Tips": "C32",
                  "SupportedNodeCountList": [
                    {
                      "StorageSize": [
                        "100"
                      ],
                      "NodeCount": {
                        "Step": "1",
                        "MinCount": "1",
                        "MaxCount": "200"
                      }
                    }
                  ],
                  "SupportedExecutorList": [
                    {
                      "NodeCount": {
                        "Step": "None",
                        "MinCount": "None",
                        "MaxCount": "None"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "SupportedComputeResource": [
        "None"
      ],
      "SupportedStorageResource": [
        "None"
      ],
      "ZoneName": "HangzhouzoneA"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.