Queries the resources of AnalyticDB for MySQL clusters that are available within one or more 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-hangzhou

The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

ZoneId String No cn-hangzhou-h

The ID of the zone. You can call the DescribeRegions operation to query the most recent zone list.

ChargeType String No PostPaid

The billing method. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Action String Yes DescribeAvailableResource

The operation that you want to perform. Set the value to DescribeAvailableResource.

AcceptLanguage String No zh-CN

The language used for the values to return. Default value: zh-CN. Valid values:

  • zh-CN: Chinese
  • en-US: English

Response parameters

Parameter Type Example Description
RegionId String cn-hangzhou

The ID of the region.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

AvailableZoneList Array of AvailableZone

The resources available in the zones.

ZoneId String cn-hangzhou-h

The ID of the zone.

SupportedMode Array of SupportedMode

The resources available in the supported modes.

Mode String flexible

The supported mode. Valid values:

  • flexible: elastic mode
  • reserver: reserved mode
SupportedSerialList Array of SupportedSerialList

The resources available in the supported editions.

Serial String mixed_storage

The supported edition. Valid values:

  • basic: Basic Edition
  • cluster: Cluster Edition
  • mixed_storage: elastic mode for Cluster Edition
SupportedFlexibleResource Array of SupportedFlexibleResource

The resources available in elastic mode.

StorageType String hdd

The storage type. Valid values:

  • hdd
  • ssd
SupportedComputeResource Array of String 32Core128GB

The available computing resources.

SupportedStorageResource Array of String None

N/A

SupportedElasticIOResource Object

The available elastic I/O units (EIUs).

Step String 1

The step size.

MinCount String 0

The minimum number of EIUs.

MaxCount String 200

The maximum number of EIUs.

SupportedInstanceClassList Array of SupportedInstanceClass

The resources available in reserved mode.

InstanceClass String C32

The available cluster specifications.

Tips String C32

The description of the cluster specifications.

SupportedNodeCountList Array of SupportedNodeCount

Details of available compute nodes.

StorageSize Array of String 100

The available storage size.

NodeCount Object

The number of available compute nodes.

Step String 1

The step size.

MinCount String 1

The minimum number of compute nodes.

MaxCount String 200

The maximum number of compute nodes.

SupportedExecutorList Array of SupportedExecutor

N/A

NodeCount Object

N/A

Step String None

N/A

MinCount String None

N/A

MaxCount String None

N/A

Examples

Sample requests

http(s)://adb.aliyuncs.com/?RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&ChargeType=PostPaid
&Action=DescribeAvailableResource
&AcceptLanguage=zh-CN
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAvailableResourceResponse>
    <RegionId>cn-hangzhou</RegionId>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <AvailableZoneList>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <SupportedMode>
            <Mode>flexible</Mode>
            <SupportedSerialList>
                <Serial>mixed_storage</Serial>
                <SupportedFlexibleResource>
                    <StorageType>hdd</StorageType>
                    <SupportedComputeResource>32Core128GB</SupportedComputeResource>
                    <SupportedElasticIOResource>
                        <Step>1</Step>
                        <MinCount>0</MinCount>
                        <MaxCount>200</MaxCount>
                    </SupportedElasticIOResource>
                </SupportedFlexibleResource>
                <SupportedInstanceClassList>
                    <InstanceClass>C32</InstanceClass>
                    <Tips>C32</Tips>
                    <SupportedNodeCountList>
                        <StorageSize>100</StorageSize>
                        <NodeCount>
                            <Step>1</Step>
                            <MinCount>1</MinCount>
                            <MaxCount>200</MaxCount>
                        </NodeCount>
                    </SupportedNodeCountList>
                </SupportedInstanceClassList>
            </SupportedSerialList>
        </SupportedMode>
    </AvailableZoneList>
</DescribeAvailableResourceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : "32Core128GB",
          "SupportedElasticIOResource" : {
            "Step" : 1,
            "MinCount" : 0,
            "MaxCount" : 200
          }
        },
        "SupportedInstanceClassList" : {
          "InstanceClass" : "C32",
          "Tips" : "C32",
          "SupportedNodeCountList" : {
            "StorageSize" : 100,
            "NodeCount" : {
              "Step" : 1,
              "MinCount" : 1,
              "MaxCount" : 200
            }
          }
        }
      }
    }
  }
}

Error codes

For a list of error codes, visit the API Error Center.