全部产品
Search
文档中心

云原生数据库 PolarDB:EvaluateRegionResource - 资源评估

更新时间:Oct 29, 2024

进行资源评估。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DBTypestring

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
DBVersionstring

数据库引擎版本号。

  • MySQL 版本号取值范围如下:
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL 版本号取值范围如下:
    • 11
    • 14
  • Oracle 版本号取值范围如下:
    • 11
    • 14
8.0
SubDomainstring

子域。即顶级域名(一级域名或父域名)的下一级。例如:父域名为:cn-beijing,则它的子域可以为 cn-beijing-i-aliyun。

cn-beijing-i-aliyun
DBNodeClassstring

节点规格,详情请参见如下文档:

polar.mysql.x4.large
DBInstanceConnTypestring

指定集群链路类型,后端随机选择默认值,取值范围如下:

  • lvs:Linux 虚拟服务器。
  • proxy:代理服务器。
  • dns:域名系统。
lvs
DispenseModestring

是否返回支持单可用区部署功能的可用区列表。取值范围如下:

  • 0(默认):不返回。
  • 1:返回。
1
NeedMaxScaleLinkstring

是否创建 Maxscale,取值范围如下:

  • true(默认):创建 Maxscale。
  • false:不创建 Maxscale。
true
ResourceGroupIdstring

资源组 ID。

rg-************
RegionIdstring

地域 ID。

说明 您可以通过 DescribeRegions 接口查看可用地域。
cn-hangzhou
ZoneIdstring

可用区 ID。

说明 您可以通过 DescribeRegions 接口查看可选的可用区。
cn-hangzhou-g

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

是否有足够的资源。

  • true:有足够的资源。
  • false:资源不足。
true
DBTypestring

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
DBVersionstring

数据库引擎版本号。

  • MySQL 版本号取值范围如下:
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL 版本号取值范围如下:
    • 11
    • 14
  • Oracle 版本号取值为 11
8.0

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidDBType.MalformedThe Specified DBType is not valid.指定的数据库类型无效.
400InvalidDBVersion.MalformedThe Specified DBVersion is not valid.指定的DBVersion无效
400InvalidDBNodeClass.MalformedThe specified parameter DBNodeClass is not valid.指定的参数DBNodeClass无效。
404SubDomain.MalformedThe specified SubDomain does not exist or ZoneId is not valid.指定的子域不存在或可用区无效。
404NeedMaxScaleLink.MalformedThe specified NeedMaxScaleLink is not valid.指定的NeedMaxScaleLink无效。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更查看变更详情
2022-09-08新增 OpenAPI查看变更详情