EvaluateRegionResource - PolarDB - Alibaba Cloud Documentation Center

Evaluates available resources.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBType	string	Yes	The type of the database engine. Valid values: MySQL PostgreSQL Oracle	MySQL
DBVersion	string	Yes	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
SubDomain	string	No	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
DBNodeClass	string	Yes	The specifications of the node. For information about node specifications, see the following topics: PolarDB for MySQL: Specifications of compute nodes PolarDB for Oracle: Specifications of compute nodes PolarDB for PostgreSQL: Specifications of compute nodes	polar.mysql.x4.large
DBInstanceConnType	string	No	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
DispenseMode	string	No	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
NeedMaxScaleLink	string	Yes	Specifies whether to create Maxscale. Valid values: true (default) false	true
ResourceGroupId	string	No	The ID of the resource group.	rg-************
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query available regions.	cn-hangzhou
ZoneId	string	Yes	The zone ID. Note You can call the DescribeRegions operation to query available zones.	cn-hangzhou-g

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	69A85BAF-1089-4CDF-A82F-0A140F******
DBInstanceAvailable	string	Indicates whether sufficient resources are available. Valid values: true false	true
DBType	string	The type of the database engine. Valid values: MySQL PostgreSQL Oracle	MySQL
DBVersion	string	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 code	Error code	Error message	Description
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
400	InvalidDBVersion.Malformed	The Specified DBVersion is not valid.	The specified DBVersion parameter is invalid.
400	InvalidDBNodeClass.Malformed	The specified parameter DBNodeClass is not valid.	The specified DBNodeClass parameter is invalid.
404	SubDomain.Malformed	The specified SubDomain does not exist or ZoneId is not valid.	The specified subdomain does not exist or the specified zone is invalid.
404	NeedMaxScaleLink.Malformed	The specified NeedMaxScaleLink is not valid.	The specified NeedMaxScaleLink parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details
2022-09-08	Add Operation	View Change Details