All Products
Search

This Product

    PolarDB:EvaluateRegionResource

    Document Center

    PolarDB:EvaluateRegionResource

    Last Updated:Dec 12, 2025

    Evaluates the resources in a region.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBType

    string

    Yes

    The database engine type. Valid values:

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    DBVersion

    string

    Yes

    The version of the database engine.

    • Valid values for MySQL:

      • 5.6

      • 5.7

      • 8.0

    • Valid values for PostgreSQL:

      • 11

      • 14

    • Valid values for Oracle:

      • 11

      • 14

    8.0
    SubDomain

    string

    No

    The subdomain. A subdomain is a level below a top-level domain. For example, if the parent domain is `cn-beijing`, a valid subdomain is `cn-beijing-i-aliyun`.

    cn-beijing-i-aliyun
    DBNodeClass

    string

    Yes

    The node specifications. For more information, see the following documents:

    polar.mysql.x4.large
    DBInstanceConnType

    string

    No

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

    • lvs: Linux Virtual Server.

    • proxy: proxy server.

    • dns: Domain Name System.

    lvs
    DispenseMode

    string

    No

    Specifies whether to return the list of zones that support single-zone deployment. Valid values:

    • 0 (default): The list is not returned.

    • 1: The list is returned.

    1
    NeedMaxScaleLink

    string

    Yes

    Specifies whether to create a MaxScale cluster. Valid values:

    • true (default): A MaxScale cluster is created.

    • false: A MaxScale cluster is not created.

    true
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-************
    RegionId

    string

    Yes

    The region ID.

    Note

    Call the DescribeRegions operation to query available regions.

    cn-hangzhou
    ZoneId

    string

    Yes

    The zone ID.

    Note

    Call the DescribeRegions operation to query the available zones.

    cn-hangzhou-g

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

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

    string

    Indicates whether the resources are sufficient.

    • true: The resources are sufficient.

    • false: The resources are insufficient.

    true
    DBType

    string

    The database engine type. Valid values:

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    DBVersion

    string

    The version of the database engine.

    • Valid values for MySQL:

      • 5.6

      • 5.7

      • 8.0

    • Valid values for PostgreSQL:

      • 11

      • 14

    • Valid value for Oracle: 11.

    8.0

    Examples

    Success response

    JSON format

    {
  "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.