全部产品
Search

搜索本产品

    云原生数据库 PolarDB：CreateDBEndpointAddress - 创建集群公网连接地址

    文档中心

    云原生数据库 PolarDB：CreateDBEndpointAddress - 创建集群公网连接地址

    更新时间：Jun 17, 2024

    创建PolarDB集群主地址、默认集群地址和自定义集群地址的公网连接地址。

    接口说明

    说明 支持为 PolarDB 集群的主地址、默认集群地址和自定义集群地址创建公网连接地址。

    调试

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

    授权信息

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

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

    请求参数

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

    集群 ID。

    		pc-**************
    DBEndpointIdstring是

    连接地址 ID。

    说明 可通过接口 DescribeDBClusterEndpoints 查询连接地址详情。
    		pe-**************
    ConnectionStringPrefixstring否

    新的连接地址前缀。连接地址前缀需满足如下条件：

    • 由小写字母、数字、中划线（-）组成。
    • 以字母开头，以数字或字母结尾。
    • 长度为 6~40 个字符。
    		test-1
    NetTypestring是

    新增连接地址的网络类型，固定为 Public（公网）。

    		Public
    VPCIdstring否

    专有网络 ID

    		vpc-**********
    SecurityGroupIdstring否

    ECS 安全组 ID

    		sg-bp**************
    ZoneInfoobject []否

    可用区信息。

    ZoneIdstring否

    可用区 ID。

    		cn-hangzhou-b
    VSwitchIdstring否

    虚拟交换机 ID。

    		vsw-**********

    返回参数

    名称类型描述示例值
    object

    1

    RequestIdstring

    请求 ID。

    		6BD9CDE4-5E7B-4BF3-9BB8-83C73E******

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******"
}

    错误码

    HTTP status code错误码错误信息描述
    400EndpointStatus.NotSupportCurrent endpoint status does not support this operation.当前节点状态不支持此操作
    400NetTypeExistsSpecified net type already existed.指定的网络类型已存在
    400MissParameter.NetTypeWhen NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.NetType 为 NlbVpc 时，VPCId、SecurityGroupId 和 ZoneInfo 不能为空。
    400InvalidDBEndpointId.MalformedThe specified parameter DBEndpointId is not valid.指定的参数DBEndpointId无效
    400InvalidNetType.MalformedThe specified parameter NetType is not valid.指定的参数NetType无效。
    400InvalidConnectionStringPrefix.MalformedThe specified parameter ConnectionStringPrefix is not valid.指定的参数ConnectionStringPrefix无效。
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
    404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      错误码 404 变更
    2023-06-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 404 变更
      删除错误码：400
    2023-05-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      删除错误码：404
    入参OpenAPI 入参发生变更。
      新增入参：VPCId
      新增入参：SecurityGroupId
      新增入参：ZoneInfo