All Products
Search
Document Center

AnalyticDB for MySQL:DescribeAvailableResource

Last Updated:Mar 15, 2024

Queries the resources of clusters within zones of a region.

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:DescribeAvailableResourceRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
ZoneIdstringNo

The zone ID.

Note You can call the DescribeRegions operation to query the most recent zone list.
cn-hangzhou-k
ChargeTypestringNo

The resources available in the supported modes.

Enumeration Value:
  • PrePaid
  • PostPaid
PostPaid
AcceptLanguagestringNo

The language of query results. Valid values:

  • zh-CN (default): Chinese.
  • en-US: English.
zh-CN
DBClusterVersionstringNo

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

3.0

Response parameters

ParameterTypeDescriptionExample
object

The supported regions.

RegionIdstring

The resources available in the supported editions.

cn-hangzhou
RequestIdstring

The ID of the request.

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

The supported zones.

ZoneIdstring

The zone ID.

cn-hangzhou-h
SupportedModeobject []

The supported modes.

Modestring

The supported mode. Valid values:

  • flexible: elastic mode.
  • reserver: reserved mode.
flexible
SupportedSerialListobject []

The supported editions.

Serialstring

The supported edition. Valid values:

  • basic: Basic Edition.
  • cluster: Cluster Edition.
  • mixed_storage: elastic mode for Cluster Edition.
mixed_storage
SupportedFlexibleResourceobject []

The supported resources in elastic mode.

StorageTypestring

The disk storage type. Valid values:

  • hdd
  • ssd
hdd
SupportedComputeResourcearray

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" ]
SupportedStorageResourcearray

The supported storage resources.

string

N/A.

N/A
SupportedElasticIOResourceobject

The supported elastic I/O resources.

Stepstring

The step size.

1
MinCountstring

The minimum amount of elastic I/O resources.

0
MaxCountstring

The maximum amount of elastic I/O resources.

200
SupportedInstanceClassListobject []

The supported resources in reserved mode.

InstanceClassstring

The supported instance type.

C32
Tipsstring

The description of the instance type.

C32
SupportedNodeCountListobject []

The supported compute nodes.

StorageSizearray

The support storage capacity. Unit: GB.

string

The support storage capacity. Unit: GB.

100
NodeCountobject

The number of the supported compute nodes.

Stepstring

The step size.

1
MinCountstring

The minimum number of compute nodes.

1
MaxCountstring

The maximum number of compute nodes.

200
SupportedExecutorListobject []

A reserved parameter.

NodeCountobject

The information about the supported compute nodes.

Stepstring

A reserved parameter.

N/A
MinCountstring

A reserved parameter.

N/A
MaxCountstring

A reserved parameter.

N/A
SupportedComputeResourcearray

A reserved parameter.

string

A reserved parameter.

N/A
SupportedStorageResourcearray

A reserved parameter.

string

A reserved parameter.

N/A

Examples

Sample success responses

JSONformat

{
  "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": [
                    "N/A"
                  ],
                  "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": "N/A",
                        "MinCount": "N/A",
                        "MaxCount": "N/A"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "SupportedComputeResource": [
        "N/A"
      ],
      "SupportedStorageResource": [
        "N/A"
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-09API Description Update. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DBClusterVersion
Output ParametersThe response structure of the API has changed.