文档

API概览

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

专有版API

API标题API概述
CreateMyBaseCreateMyBase创建MyBase专有版主机,如未提供集群信息会自动创建MyBase专有版集群。

托管版API

API标题API概述
地域地域
DescribeRegions查看可选的地域和可用区调用DescribeRegions接口查看地域ID。
集群管理集群管理
CreateDedicatedHostGroup创建专属集群调用CreateDedicatedHostGroup接口创建专属集群。
DeleteDedicatedHostGroup删除专属集群调用DeleteDedicatedHostGroup接口删除专属集群。
ModifyDedicatedHostGroupAttribute修改专属集群的配置可修改的配置包括 CPU 超配比、内存使用率、空间超配比、资源分布策略等。
DescribeDedicatedHostGroups查询专属集群主机组信息查询专有集群主机组信息。
主机管理主机管理
CreateDedicatedHost添加专属集群主机调用CreateDedicatedHost接口添加专属集群主机。
DescribeDedicatedHosts查询专属集群的主机信息可以来查询专属集群的主机信息。
DescribeDedicatedHostAttribute查询专属集群某个主机的参数信息调用DescribeDedicatedHostAttribute接口查询专属集群某个主机的参数信息。
DescribeHostEcsLevelInfo查询主机规格详细信息调用DescribeHostEcsLevelInfo查询主机规格详细信息。
DescribeDedicatedHostDisks查询主机上的磁盘信息调用DescribeDedicatedHostDisks接口查询主机上的磁盘信息。
ModifyDedicatedHostAttribute设置专属集群的主机是否允许分配实例调用ModifyDedicatedHostAttribute接口设置专属集群的主机是否允许分配实例。
ReplaceDedicatedHost替换专属集群的主机调用ReplaceDedicatedHost接口替换专属集群的主机。
RestartDedicatedHost重启专属集群的主机调用RestartDedicatedHost接口重启专属集群的主机。
DescribeHostWebShell获取专属集群主机 Webshell 登录地址调用DescribeHostWebShell接口获取专属集群主机Webshell登录地址。
ModifyDedicatedHostClass升配主机的规格调用ModifyDedicatedHostClass接口升配主机的规格。
TagResources为一个或多个主机绑定标签为一个或多个主机绑定标签。
ListTagResources调用 ListTagResources 查询主机和标签的绑定关系查询主机和标签的绑定关系。
UntagResources将主机的标签解绑将主机的标签解绑。
主机账号管理主机账号管理
CreateDedicatedHostAccount创建专用主机帐户调用CreateDedicatedHostAccount接口创建主机账号。
DeleteDedicatedHostAccount删除专属主机账号调用DeleteDedicatedHostAccount接口删除主机账号。
ModifyDedicatedHostPassword修改专属主机密码调用ModifyDedicatedHostPassword接口修改主机root密码。
ModifyDedicatedHostAccount修改专属集群主机账号调用ModifyDedicatedHostAccount接口修改主机账号和密码。
实例管理实例管理
QueryHostInstanceConsoleInfo查询主机实例节点列表调用QueryHostInstanceConsoleInfo接口查询主机实例节点列表。
QueryHostBaseInfoByInstance查看实例所在主机基本信息调用QueryHostBaseInfoByInstance接口查询实例所在主机基本信息。