All Products
Search
Document Center

PolarDB:EvaluateRegionResource

Last Updated:Mar 01, 2024

Evaluates available resources.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBTypestringYes

The type of the database engine. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
DBVersionstringYes

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

8.0
SubDomainstringNo

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.

cn-beijing-i-aliyun
DBNodeClassstringYes

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

polar.mysql.x4.large
DBInstanceConnTypestringNo

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

  • lvs :Linux virtual server
  • proxy: proxy server
  • dns: domain name system
lvs
DispenseModestringNo

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.
1
NeedMaxScaleLinkstringYes

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

  • true
  • false
true
ResourceGroupIdstringNo

The ID of the resource group.

rg-************
RegionIdstringYes

The region ID.

Note You can call the DescribeRegions operation to query available regions.
cn-hangzhou
ZoneIdstringYes

The zone ID.

Note You can call the DescribeRegions operation to query available zones.
cn-hangzhou-g

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

69A85BAF-1089-4CDF-A82F-0A140F******
DBInstanceAvailablestring

Indicates whether sufficient resources are available. Valid values:

  • true
  • false
true
DBTypestring

The type of the database engine. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
DBVersionstring

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

8.0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBType.MalformedThe Specified DBType is not valid.The specified database type is invalid.
400InvalidDBVersion.MalformedThe Specified DBVersion is not valid.The specified DBVersion parameter is invalid.
404SubDomain.MalformedThe specified SubDomain does not exist or ZoneId is not valid.The specified subdomain does not exist or the specified zone is invalid.

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

Change history

Change timeSummary of changesOperation
2023-09-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 404 change
2022-09-08Add Operationsee changesets