API概览

本产品(云数据库 SelectDB 版/2023-05-22)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例管理

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

集群管理

API标题API概述
CreateDBCluster创建集群为指定云数据库SelectDB版实例创建集群。
GetCreateBEClusterInquiry新建集群询价指定云数据库SelectDB版实例下新建集群时获取价格信息。
GetModifyBEClusterInquiry集群变配询价指定云数据库SelectDB版实例下新建集群时获取价格信息。
ModifyDBCluster集群扩缩容为指定云数据库SelectDB版实例的集群扩缩容。
ModifyBEClusterAttribute修改集群名修改云数据库SelectDB版实例的集群名称。
StopBECluster停止集群停止指定云数据库SelectDB版集群。
StartBECluster启动集群启动指定云数据库SelectDB版集群。
RestartDBCluster重启集群重启指定云数据库SelectDB版实例的集群。
DeleteDBCluster删除集群删除指定云数据库SelectDB版实例的集群。
DescribeDBClusterConfig查看集群配置查看集群配置。
ModifyDBClusterConfig修改集群配置修改集群配置。
DescribeDBClusterConfigChangeLogs查看集群配置变更记录查看集群配置变更记录。

其他

API标题API概述
DescribeAllDBInstanceClass获取所有实例规格信息获取所有实例规格信息