该接口用于创建RDS AI应用实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rdsai:CreateAppInstance | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-beijing |
| AppType | string | 否 | 应用类型。当前仅支持 supabase。 | supabase |
| VSwitchId | string | 否 | 虚拟交换机 ID。 | vsw-9dp2hkpm22gxscfgy**** |
| InstanceClass | string | 否 | 实例的规格。当前仅支持rdsai.supabase.basic。 | rdsai.supabase.basic |
| DBInstanceName | string | 否 | AI 应用接入的 RDS PostgreSQL 数据库实例 ID。 注意 仅支持新购的 RDS PostgreSQL 空实例，且其大版本为 17，小版本为20250630 及以上。 | pgm-2ze49qv594vi**** |
| AppName | string | 否 | 新建 AI 应用的名称。 | test-supabase |
| ClientToken | string | 否 | 幂等参数。由客户端生成该参数值，用于保证请求的幂等性，防止重复提交请求。 | ETnLKlblzczshOTUbOCz**** |
| DatabasePassword | string | 否 | RDS 数据库访问密码。 密码长度为 8～32 位，且必须包含三种及以上以下字符：大写字母、小写字母、数字、下划线（_）。 | test_Password |
| DashboardUsername | string | 否 | Supabase Dashboard 用户。 | supabase |
| DashboardPassword | string | 否 | Supabase Dashboard 密码。 密码长度为 8～32 位，且必须包含三种及以上以下字符：大写字母、小写字母、数字、下划线（_）。 | test_Password |
| PublicNetworkAccessEnabled | boolean | 否 | 是否开启公网 NAT 网关。取值：
注意 如果已经为 VSwitchId 参数配置的交换机开通了公网 NAT 网关，此参数值请选择 false。 | false |
| RAGEnabled | boolean | 否 | 预留参数 | |
| DBInstanceConfig | object | 否 | 数据库实例配置 | |
| DBInstanceClass | string | 否 | 数据库实例的实例规格 | pg.n2.2c.1m |
| DBInstanceStorage | integer | 否 | 数据库实例存储容量 | 100 |
| PayType | string | 否 | 数据库实例付费类型 | Postpaid |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "FE9C65D7-930F-57A5-A207-8C396329241C",
"InstanceName": "ra-supabase-8moov5lxba****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IncorrectInstanceState | Current instance status does not support this operation. | 当前实例状态不支持该操作 |
| 400 | InvalidGroupName | Specified group name is not valid. | 分组名称无效 |
| 400 | InvalidParameter | The provided parameter is invalid. | 无效的参数。 |
| 400 | MasterInstanceNotExist | Master instance does not exist. | 主实例不存在。 |
| 403 | InsufficientResourceCapacity | There is not enough host resource inventory. | 资源不足 |
访问错误中心查看更多错误码。