进行资源评估。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| DBType | string | 是 | 数据库引擎类型,取值范围如下: 
 | MySQL | 
| DBVersion | string | 是 | 数据库引擎版本号。 
 | 8.0 | 
| SubDomain | string | 否 | 子域。即顶级域名(一级域名或父域名)的下一级。例如:父域名为:cn-beijing,则它的子域可以为 cn-beijing-i-aliyun。 | cn-beijing-i-aliyun | 
| DBNodeClass | string | 是 | polar.mysql.x4.large | |
| DBInstanceConnType | string | 否 | 指定集群链路类型,后端随机选择默认值,取值范围如下: 
 | lvs | 
| DispenseMode | string | 否 | 是否返回支持单可用区部署功能的可用区列表。取值范围如下: 
 | 1 | 
| NeedMaxScaleLink | string | 是 | 是否创建 Maxscale,取值范围如下: 
 | true | 
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-************ | 
| RegionId | string | 是 | 地域 ID。 说明 
您可以通过 DescribeRegions 接口查看可用地域。
 | cn-hangzhou | 
| ZoneId | string | 是 | 可用区 ID。 说明 
您可以通过 DescribeRegions 接口查看可选的可用区。
 | cn-hangzhou-g | 
返回参数
示例
正常返回示例
JSON格式
{
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "DBInstanceAvailable": true,
  "DBType": "MySQL",
  "DBVersion": 8
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 400 | InvalidDBType.Malformed | The Specified DBType is not valid. | 指定的数据库类型无效. | 
| 400 | InvalidDBVersion.Malformed | The Specified DBVersion is not valid. | 指定的DBVersion无效 | 
| 400 | InvalidDBNodeClass.Malformed | The specified parameter DBNodeClass is not valid. | 指定的参数DBNodeClass无效。 | 
| 404 | SubDomain.Malformed | The specified SubDomain does not exist or ZoneId is not valid. | 指定的子域不存在或可用区无效。 | 
| 404 | NeedMaxScaleLink.Malformed | The specified NeedMaxScaleLink is not valid. | 指定的NeedMaxScaleLink无效。 | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 | 
| 2022-09-08 | 新增 OpenAPI | 查看变更详情 | 
