API概览

本产品(selectdb/2023-05-22)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例管理

API

标题

API概述

CreateDBInstance 创建实例 创建一个云数据库 SelectDB 版实例。
CreateServiceLinkedRoleForSelectDB 创建服务关联角色 调用该接口创建服务关联角色。
CheckServiceLinkedRole 检查服务关联角色 调用该接口检查服务关联角色。
CheckCreateDBInstance 创建实例前的预检查 创建云数据库SelectDB版实例前的预检查。
DescribeDBInstances 查询实例 查询实例列表。
DescribeDBInstanceAttribute 查询实例详情 查询实例详情。
ResetAccountPassword 重置账号密码 重置云数据库SelectDB版实例的账号密码。
DescribeDBInstanceNetInfo 查询实例网络信息 查询指定云数据库SelectDB版实例的网络信息。
DescribeSecurityIPList 查询实例白名单IP 查询指定云数据库SelectDB版实例的白名单IP。
ModifySecurityIPList 修改白名单 修改指定云数据库SelectDB版实例的白名单IP。
CheckIpExistsInSecurityIpList 判断指定 IP 是否已经存在于网络白名单组 判断指定 IP 是否已经存在于网络白名单组。
ModifyDBInstanceAttribute 修改实例运维时间或备注信息 修改指定云数据库SelectDB版实例的运维时间或备注信息。
UpgradeDBInstanceEngineVersion 升级数据库版本 升级指定云数据库SelectDB版实例的数据库版本。
AllocateInstancePublicConnection 申请公网地址 为指定云数据库SelectDB版实例申请公网地址。
ReleaseInstancePublicConnection 释放公网地址 释放指定云数据库SelectDB版实例的公网地址。
DeleteDBInstance 删除实例 删除指定云数据库SelectDB版实例。

集群管理

API

标题

API概述

CreateDBClusterBinding 创建集群绑定 部署模式为同城冗余的实例,两个集群间可创建互相绑定关系。
DeleteDBClusterBinding 删除集群绑定 删除两集群间的互备绑定关系。
CreateDBCluster 创建集群 为指定云数据库SelectDB版实例创建集群。
GetCreateBEClusterInquiry 新建集群询价 指定云数据库SelectDB版实例下新建集群时获取价格信息。
GetModifyBEClusterInquiry 集群变配询价 指定云数据库SelectDB版实例下新建集群时获取价格信息。
ModifyDBCluster 集群扩缩容 为指定云数据库SelectDB版实例的集群扩缩容。
ModifyBEClusterAttribute 修改集群名 修改云数据库SelectDB版实例的集群名称。
StopBECluster 停止集群 停止指定云数据库SelectDB版集群。
StartBECluster 启动集群 启动指定云数据库SelectDB版集群。
RestartDBCluster 重启集群 重启指定云数据库SelectDB版实例的集群。
DeleteDBCluster 删除集群 删除实例下集群。
DescribeDBClusterConfig 查看集群配置 查看集群配置。
ModifyDBClusterConfig 修改集群配置 修改集群配置。
DescribeDBClusterConfigChangeLogs 查看集群配置变更记录 查看集群配置变更记录。

其他

API

标题

API概述

UntagResources 实例去除标签 实例去除标签