AllocateClusterPublicConnection - 申请公网地址

更新时间:
复制为 MD 格式

为集群申请公网连接地址。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:AllocateClusterPublicConnection

update

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

企业版、基础版或湖仓版的集群 ID。

amv-bp1z5d2q71is2****

ConnectionStringPrefix

string

定义公网连接地址的前缀。

  • 以小写字母开头,可包含小写字母、数字和中划线(-);

  • 长度不超过 30 个字符。

test12

Engine

string

数据库引擎,取值:

  • AnalyticDB(默认):AnalyticDB for MySQL 引擎。

  • Clickhouse:宽表引擎。

枚举值:

  • AnalyticDB :

    AnalyticDB

  • Clickhouse :

    Clickhouse

Clickhouse

ResourceGroupName

string

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

868EF07F-D0B2-5043-B092-0C14CD00B65A

示例

正常返回示例

JSON格式

{
  "RequestId": "868EF07F-D0B2-5043-B092-0C14CD00B65A"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidConnectionStringPrefix.Malformed The specified connection string is invalid. 连接地址无效
400 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. DBClusterId参数不正确,请确认参数是否符合规范。
400 ACS.InvalidParameter.%s Parameter %s is invalid. 输入的参数无效

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

变更历史

更多信息,参考变更详情