Evaluates available resources.

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
Action String Yes EvaluateRegionResource

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

DBType String Yes MySQL

The type of the database engine. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String Yes 8.0

The version of the database engine.

  • Valid values for the MySQL database engine:
    • 5.6
    • 5.7
    • 8.0
  • Valid values for the PostgreSQL database engine:
    • 11
    • 14
  • Valid value for the Oracle database engine: 11
SubDomain String No cn-beijing-i-aliyun

The subdomain. It is the child domain of the top-level domain name or parent domain. For example, if the parent domain name is cn-beijing, its child domain can be cn-beijing-i-aliyun.

DBNodeClass String Yes polar.mysql.x4.large

The specifications of the node. For information about node specifications, see the following topics:

DBInstanceConnType String No lvs

The cluster link type. The backend randomly selects the default value. Default value: 0. Valid values:

  • lvs :Linux virtual server
  • proxy: proxy server
  • dns: domain name system
DispenseMode String No 1

Specifies whether to return the zones in which the single-zone deployment method is supported. Default value: 0. Valid values:

  • 0: no value returned
  • 1: returns the zones.
NeedMaxScaleLink String Yes true

Specifies whether Maxscale is created. Default value: true. Valid values:

  • true
  • false
ResourceGroupId String No rg-************

The ID of the resource group.

RegionId String Yes cn-hangzhou

The region ID of the cluster.

Note You can call the DescribeRegions operation to query available regions.
ZoneId String Yes cn-hangzhou-g

The zone ID of the cluster.

Note You can call the DescribeRegions operation to query available zones.

Response parameters

Parameter Type Example Description
RequestId String 69A85BAF-1089-4CDF-A82F-0A140F******

The ID of the request.

DBInstanceAvailable String true

Indicates whether sufficient resources are available. Valid values:

  • true
  • false
DBType String MySQL

The type of the database engine. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 8.0

The version of the database engine.

  • Valid values for the MySQL database engine:
    • 5.6
    • 5.7
    • 8.0
  • Valid values for the PostgreSQL database engine:
    • 11
    • 14
  • Valid value for the Oracle database engine: 11

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=EvaluateRegionResource
&DBType=MySQL
&DBVersion=8.0
&SubDomain=cn-beijing-i-aliyun
&DBNodeClass=polar.mysql.x4.large
&DBInstanceConnType=lvs
&DispenseMode=1
&NeedMaxScaleLink=true
&ResourceGroupId=rg-************
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-g
&<Common request parameters>

Sample success responses

XML format

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

<EvaluateRegionResourceResponse>
    <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>
    <DBInstanceAvailable>true</DBInstanceAvailable>
    <DBType>MySQL</DBType>
    <DBVersion>8.0</DBVersion>
</EvaluateRegionResourceResponse>

JSON format

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

{
  "RequestId" : "69A85BAF-1089-4CDF-A82F-0A140F******",
  "DBInstanceAvailable" : "true",
  "DBType" : "MySQL",
  "DBVersion" : "8.0"
}

Error codes

HTTP status code Error code Error message Description
400 InvalidDBType.Malformed The Specified DBType is not valid. The error message returned because the specified database type is invalid.
400 InvalidDBVersion.Malformed The Specified DBVersion is not valid. The error message returned because the specified DBVersion parameter is invalid.
404 SubDomain.Malformed The specified SubDomain does not exist or ZoneId is not valid. The error message returned because the specified subdomain does not exist or the specified zone is invalid.

For a list of error codes, see Service error codes.