API概览
更新时间：
复制 MD 格式
API标准及多语言预置SDK
本产品（DBFS/2020-04-18）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
实例基本操作
|
API |
标题 |
API概述 |
| CreateDbfs | 创建数据库文件系统 | 调用CreateDbfs创建一个按量付费的数据库文件系统。 |
| UpdateDbfs | 修改数据库文件系统 | 修改一个数据库文件系统的实例规格和使用场景。 |
| DeleteDbfs | 删除数据库文件系统 | 调用DeleteDbfs释放一个按量付费的数据库文件系统。 |
| AttachDbfs | 挂载数据库文件系统 | 调用AttachDbfs为一台ECS实例挂载一个按量付费的数据库文件系统。ECS实例和数据库文件系统必须在同一个可用区内。 |
| DetachDbfs | 卸载数据库文件系统 | 调用DetachDbfs从一台ECS实例上卸载一个按量付费的数据库文件系统。 |
| RenameDbfs | 重命名数据库文件系统 | 调用RenameDbfs重命名一个数据库文件系统。 |
| ResizeDbfs | 扩容数据库文件系统 | 调用ResizeDbfs扩容一个数据库文件系统。 |
| ListDbfs | 查询数据库文件系统列表 | 调用ListDbfs查询您已经创建的数据库文件系统列表。 |
| GetDbfs | 查询单个数据库文件系统 | 调用GetDbfs查询数据库文件系统详细信息。 |
| ListDbfsAttachableEcsInstances | 查询可挂载的ECS实例 | 调用ListDbfsAttachableEcsInstances查询数据库文件系统可挂载的ECS实例列表。 |
| ListDbfsAttachedEcsInstances | 查询已挂载的ECS实例 | 调用ListDbfsAttachedEcsInstances查询数据库文件系统已挂载的ECS实例列表。 |
快照
|
API |
标题 |
API概述 |
| CreateSnapshot | 创建快照 | 调用CreateSnapshot给一个数据库文件系统创建快照。 |
| DeleteSnapshot | 删除快照 | 调用DeleteSnapshot删除一个或多个数据库文件系统的快照。 |
| ModifySnapshotAttribute | 修改快照属性 | 修改一份快照的名称、描述。 |
| ListSnapshot | 查询快照 | 调用ListSnapshot查询用户创建的数据库文件系统快照列表。 |
| GetSnapshotLink | 获取单个快照链 | 查询数据库文件系统快照链。快照链是一个数据库文件系统所有快照组成的关系链，一个文件系统对应一条快照链。 |
| ListSnapshotLinks | 查询快照链 | 查询某个地域下满足条件的快照链。 |
| 自动快照策略 | 自动快照策略 | |
| CreateAutoSnapshotPolicy | 创建自动快照策略 | 在指定地域下创建一条自动快照策略。自动快照策略可以周期性地为数据库文件系统创建快照备份数据。 |
| CancelAutoSnapshotPolicy | 取消自动快照策略 | 取消一个或多个数据库文件系统的自动快照策略。 |
| ApplyAutoSnapshotPolicy | 设置自动快照策略 | 为一个或多个数据库文件系统设置自动快照策略。 |
| DeleteAutoSnapshotPolicy | 删除自动快照策略 | 删除一条自动快照策略。删除后，已经设置了该自动快照策略的文件系统将自动取消策略。 |
| ModifyAutoSnapshotPolicy | 修改自动快照策略 | 修改一条自动快照策略。修改自动快照策略后，之前已设置该策略的数据库文件系统随即执行修改后的自动快照策略。 |
| GetAutoSnapshotPolicy | 查询单个自动快照策略 | 查询单个自动快照策略。 |
| ListAutoSnapshotPolicies | 列出自动快照策略 | 查询您在某个地域下，所有已创建的符合查询条件的自动快照策略。 |
| ListAutoSnapshotPolicyUnappliedDbfs | 列出未设置自动快照策略的文件系统 | 查询您在某个地域下，所有已创建的符合查询条件的未设置自动快照策略的数据库文件系统。 |
| ListAutoSnapshotPolicyAppliedDbfs | 列出该自动快照策略已设置的文件系统 | 查询所有已设置该自动快照策略的数据库文件系统列表。 |
标签
|
API |
标题 |
API概述 |
| DeleteTagsBatch | 批量删除标签 | 调用DeleteTagsBatch批量删除多个数据库文件系统实例的标签。 |
| TagDbfs | 设置标签 | 调用TagDbfs为一个数据库文件系统设置标签。 |
| AddTagsBatch | 批量设置标签 | 调用AddTagsBatch为多个数据库文件系统实例批量添加标签，可能存在新增标签与替换标签。 |
| ListTagKeys | 查询标签键 | 调用ListTagKeys查询用户创建的所有标签键。 |
| ListTagValues | 查询标签值 | 调用ListTagValues查询标签键下的所有标签值。 |
服务关联角色
|
API |
标题 |
API概述 |
| CreateServiceLinkedRole | 创建服务关联角色 | 调用CreateServiceLinkedRole创建服务关联角色，用于DBFS操作其它依赖的云资源。 |
| GetServiceLinkedRole | 查询服务关联角色 | 调用GetServiceLinkedRole查询用户是否已经创建过服务关联角色。 |
其他
|
API |
标题 |
API概述 |
| DescribeDbfsSpecifications | 查询DBFS规格信息 | 调用DescribeDbfsSpecifications查询DBFS的规格信息。 |
| DescribeInstanceTypes | 查询实例规格 | 调用DescribeInstanceTypes查询DBFS支持的实例规格列表。 |
该文章对您有帮助吗？