接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
- RDS MySQL申请外网连接地址
- RDS PostgreSQL申请外网连接地址
- RDS SQL Server申请外网连接地址
- RDS MariaDB申请外网连接地址
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:AllocateInstancePublicConnection | Write |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
ConnectionStringPrefix | string | 是 |
外网连接地址的前缀。完整外网连接地址为: 说明 | test1234 |
Port | string | 是 | 外网连接端口,取值:1000~5999。 |
3306 |
BabelfishPort | string | 否 |
Babelfish for RDS PostgreSQL TDS端口号。 说明 | 1433 |
GeneralGroupName | string | 否 | 专属集群MySQL通用版实例所属的组名。 |
rgc-bp1tkv8**** |
PGBouncerPort | string | 否 |
PgBouncer端口。 说明 | 6432 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | 返回参数详情。 |
||
DbInstanceName | string |
实例ID。 |
rm-bp1**** |
RequestId | string |
请求ID。 |
65BDA532-28AF-4122-AA39-B382721EEE64 |
ConnectionString | string |
数据库连接地址。 |
test****.mysql.rds.aliyuncs.com |
示例
正常返回示例
JSON
格式
{
"DbInstanceName": "rm-bp1****",
"RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64",
"ConnectionString": "test****.mysql.rds.aliyuncs.com"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OtherEndpoint.Exist | Other endpoint exist. | 外网连接地址的前缀已存在 |
400 | IncorrectDBInstanceState | The current instance state does not support this operation. | 当前实例状态不支持此操作。 |
400 | ConnectionStringContainIllegalCharacterFault | The connection string contain Illegal character. | 连接字符串内容存在非法字符错误,请修改后重试。 |
400 | InvalidInstanceNetworkType | The specified InstanceNetworkType is invalid. | 指定的实例网络类型无效 |
400 | InvalidConnectionString.Format | Specified connection string is not valid. | 实例连接地址的字符串格式不正确。字符串前缀长度为5~40。 |
400 | InvalidPort.Malformed | Specified port is not valid. | 指定的端口无效。 |
400 | InvalidVpcIdRegion.NotSupported | The specified region does not allow you to create a VPC instance. | 操作失败,该地区不支持创建VPC实例。 |
400 | InvalidInstanceNetworkType.ValueNotSupported | The specified parameter “InstanceNetworkType” is not valid. | 网络类型验证失败,支持的网络类型为VPC和Classic。 |
400 | InvalidBizType.Format | Specified biz type is not valid. | 当前业务类型不支持该操作。 |
400 | EndpointNum.Error | The number of endpoint is too many. | Endpoint的数量过多,无法继续创建。 |
400 | EndpointNum.Error | Endpoint number error. | 端口数量错误。 |
403 | Invalid.DbInstanceNetType | The specified parameter DbInstanceNetType is not valid. | 实例网络类型无效。请设置为Internet(经典网络)或Intranet(专有网络)。 |
403 | OperationDenied.SwitchToVPC | Specified instance cannot be switched to VPC. | 当前实例无法切换VPC。 |
404 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 链接地址名重复,请重新设置连接字符串。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|
||||||||||||
2023-06-27 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|
||||||||||||
2023-06-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|
||||||||||||
2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|
||||||||||||
2022-06-23 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|
||||||||||||
2022-02-23 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/155590.html