API标准及多语言预置SDK
本产品（cddc/2020-03-20）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
专有版API
|
API |
标题 |
API概述 |
| CreateMyBase | CreateMyBase | 创建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 | 修改专属集群主机账号 | 修改专属集群主机账号。 |
| 实例管理 | 实例管理 | |
| QueryHostInstanceConsoleInfo | 查询主机实例节点列表 | 调用QueryHostInstanceConsoleInfo接口查询主机实例节点列表。 |
| QueryHostBaseInfoByInstance | 查看实例所在主机基本信息 | 调用QueryHostBaseInfoByInstance接口查询实例所在主机基本信息。 |
开放版 API
|
API |
标题 |
API概述 |
| AddPrinsInstance | 添加纳管实例 | 添加 MyBase 自建纳管实例。 |
| CreatePrinsBackupPlan | 创建备份计划 | 为纳管实例创建备份计划。 |
| DescribePrinsInstance | 获取纳管实例详情 | 获取纳管实例详情。 |
| DescribePrinsBackupPlan | 查询备份计划详情 | 查询在 MyBase 实例纳管页创建的 DBS 备份计划详情，返回为空时说明纳管实例未创建备份计划。 |
| DescribePrinsEcsInstances | 查询 ECS 实例列表 | 查询ECS实例信息列表。 |
| GetPrinsEventList | 获取实例事件列表 | 获取事件列表。 |
| GetPrinsMetricsList | 获取实例性能指标 | 获取纳管实例性能指标数据。 |
| ListPrinsSQLErrorLog | 查询数据库错误日志 | 查询数据库错误日志。 |
| ListPrinsParams | 查询数据库参数列表 | 查询数据库纳管实例参数列表。 |
| ListPrinsInstances | 查询纳管实例列表 | 查询纳管实例列表。 |
该文章对您有帮助吗？