创建PolarDB自定义集群地址。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:CreateDBClusterEndpoint | create | *DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 | pc-************** |
EndpointType | string | 是 | 自定义集群地址类型,取值固定为 Custom。 | Custom |
Nodes | string | 否 | 加入目标地址的读负载节点,多个节点间用英文逗号(,)分隔。 默认为全部节点。 说明
Writer,Reader1,Reader2 。 | pi-**********,pi-********* |
ReadWriteMode | string | 否 | 读写模式,取值范围如下:
| ReadOnly |
AutoAddNewNodes | string | 否 | 新节点是否自动加入本地址,取值范围如下:
| Disable |
EndpointConfig | string | 否 | 集群地址的高级配置,格式为 JSON,目前支持设置一致性级别、事务拆分、主库不接受读和连接池。
说明
{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"} 。 | {"ConsistLevel": "1","DistributedTransaction": "on"} |
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。 | 6000170000591aed949d0f****************** |
DBEndpointDescription | string | 否 | 自定义集群地址名称。 | test |
SccMode | string | 否 | 节点是否开启全局一致性(高性能模式)功能。取值范围如下:
| on |
PolarSccWaitTimeout | string | 否 | 全局一致性超时时间 | 100 |
PolarSccTimeoutAction | string | 否 | 全局一致性超时策略。取值范围如下:
| 0 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CD35F3-F3-44CA-AFFF-BAF869******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ClusterEndpoint.StatusNotValid | Cluster endpoint status is not valid. | 集群地址的状态无效. |
400 | EndpointNum.Error | Endpoint number error. | Endpoint数量超过限制 |
400 | LockTimeout | The request processing has failed due to lock timeout. | 由于锁定超时,请求处理失败 |
404 | EndpointConfig.Invalid | Endpoint config is invalid. | 集群地址的高级配置参数无效 |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
404 | EndpointConfig.Conflict | Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled. | Endpoint配置无效,CausalConsistRead应为会话,因为节点的全局一致性(高性能模式)已启用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-30 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-11-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-09-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-07-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-04-25 | OpenAPI 错误码发生变更 | 查看变更详情 |