全部产品
Search

搜索本产品

    云数据库 RDS：AllocateInstancePublicConnection - 申请外网连接地址

    文档中心

    云数据库 RDS：AllocateInstancePublicConnection - 申请外网连接地址

    更新时间：Jun 02, 2023

    该接口用于为RDS实例申请外网连接地址。

    接口说明

    适用引擎

    • RDS MySQL
    • RDS PostgreSQL
    • RDS SQL Server
    • RDS MariaDB

    相关功能文档

    注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    rds:AllocateInstancePublicConnectionWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		无

    请求参数

    名称类型必填描述示例值
    DBInstanceIdstring是

    实例ID。可调用DescribeDBInstances获取。

    		rm-uf6wjk5****
    ConnectionStringPrefixstring是

    外网连接地址的前缀。完整外网连接地址为：前缀.引擎名.rds.aliyuncs.com。例如test1234.mysql.rds.aliyuncs.com。

    说明长度5~40，不能包含汉字和非法字符（~!#%^&*=+|{};:'",<>/?），建议由字母、数字、短横线（-）组成。
    		test1234
    Portstring是

    外网连接端口，取值：1000~5999。

    		3306
    BabelfishPortstring否

    Babelfish for RDS PostgreSQL TDS端口号。

    说明该参数仅适用于RDS PostgreSQL实例，Babelfish for RDS PostgreSQL的更多介绍，请参见Babelfish简介。
    		1433
    GeneralGroupNamestring否

    专属集群MySQL通用版实例所属的组名。

    		rgc-bp1tkv8****

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    DbInstanceNamestring

    实例ID。

    		rm-bp1****
    RequestIdstring

    请求ID。

    		65BDA532-28AF-4122-AA39-B382721EEE64
    ConnectionStringstring

    数据库连接地址。

    		test****.mysql.rds.aliyuncs.com

    示例

    正常返回示例

    JSON格式

    {
  "DbInstanceName": "rm-bp1****",
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64",
  "ConnectionString": "test****.mysql.rds.aliyuncs.com"
}

    错误码

    HTTP status code错误码错误信息描述
    400OtherEndpoint.ExistOther endpoint exist.外网连接地址的前缀已存在
    400IncorrectDBInstanceStateThe current instance state does not support this operation.当前实例状态不支持此操作。
    400ConnectionStringContainIllegalCharacterFaultThe connection string contain Illegal character.连接字符串内容存在非法字符错误，请修改后重试。
    400InvalidInstanceNetworkTypeThe specified InstanceNetworkType is invalid.指定的实例网络类型无效
    400InvalidConnectionString.FormatSpecified connection string is not valid.实例连接地址的字符串格式不正确。字符串前缀长度为5~40。
    400InvalidPort.MalformedSpecified port is not valid.指定的端口无效。
    400InvalidVpcIdRegion.NotSupportedThe specified region does not allow you to create a VPC instance.操作失败，该地区不支持创建VPC实例。
    400InvalidInstanceNetworkType.ValueNotSupportedThe specified parameter "InstanceNetworkType" is not valid.网络类型验证失败，支持的网络类型为VPC和Classic。
    403Invalid.DbInstanceNetTypeThe specified parameter DbInstanceNetType is not valid.实例网络类型无效。请设置为Internet（经典网络）或Intranet（专有网络）。
    403OperationDenied.SwitchToVPCSpecified instance cannot be switched to VPC.当前实例无法切换VPC。

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

    变更历史

    变更时间变更内容概要操作
    2022-10-28OpenAPI 错误码发生变更
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      新增错误码：403
    2022-06-23OpenAPI 描述信息更新，OpenAPI 错误码发生变更
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码：400
    2022-02-23OpenAPI 错误码发生变更，OpenAPI 入参发生变更
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码：400
    入参OpenAPI 入参发生变更
      新增入参：BabelfishPort