API标准及多语言预置SDK
本产品（BPStudio/2021-09-31）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
模板
|
API |
标题 |
API概述 |
| ValuateTemplate | 模板实时询价 | 查询模板价格。 |
| GetLinkageAttributesTemplate | 获取模板变参可选值 | 获取模板变参可选值 |
应用
|
API |
标题 |
API概述 |
| GetApplicationVariables | 获取应用输入参数 | 获取一个应用的所有输入的模版变量的值。 |
| ReConfigApplication | 更新应用属性 | 用户可以从上面函数获取到需要重新配置的模版变量列表。然后对这些变量重新赋值后，调用本函数，应用状态会变为“修改中”，同时失败节点的属性值会根据传入的模版变量值重新赋值（例如：修改了失败资源的实例类型等）。执行该函数后，用户可以重新部署该应用。 |
| GetApplicationVariables4Fail | 查询“部分部署成功”的应用中和部署失败的资源节点相关的模版变量列表 | 获取需要重新配置的变量列表。 |
| ListApplication | 获取应用列表 | 该接口提供当前用户下所有应用的列表。其中可选参数keyword定义应用名中包含的关键字。 |
| DeployApplication | 部署应用 | 计费成功后，创建资源。 |
| ReleaseApplication | 释放应用 | 该接口释放应用的资源。 |
| ValidateApplication | 应用校验 | 对应用下的资源输入的合法性进行校验，异步执行，校验结果调用GetApplication获取。 |
| ValuateApplication | 应用计费 | 对应用下的资源进行询价，通过GetApplication获取询价结果。 |
| GetResource4ModifyRecord | 获取应用变配记录 | 获取询价应用变配记录。 |
| GetResult4QueryInstancePrice4Modify | 获取询价结果 | 获取询价结果。 |
| ModifyApplicationSpec | 提交应用变配 | 提交应用变配。 |
| QueryInstancePrice4Modify | 查询变配价格 | 查询变配价格。 |
| QueryInstanceSpec4Modify | 查询变配规格列表 | 查询变配规格列表。 |
应用操作
|
API |
标题 |
API概述 |
| ExecuteOperationSync | 同步执行操作 | 维护应用下资源API（同步操作） |
| ExecuteOperationASync | 异步执行操作 | 异步执行产品操作功能。 |
| GetExecuteOperationResult | 异步获取操作结果 | 异步获取操作结果。 |
| GetOperationParams | 查看某操作的输入参数 | 查看某操作的输入参数 |
容灾服务
|
API |
标题 |
API概述 |
| AppFailOver | 容灾应用切换 | 将容灾集切换至支持的可用区。 |
| GetPotentialFailZones | 获取容灾服务可切换的可用区列表 | 获取指定容灾服务可切换的可用区列表。 |
| GetFoTaskStatus | 获取指定容灾任务的状态 | 获取指定容灾任务（TaskId）的状态。 |
| AppFailBack | 容灾应用切回 | 将容灾集切回至主可用区。 |
| ListFoCreatedApps | 查询所有容灾服务计划 | 接口查询当前账户下所有容灾服务计划。 |
| InitAppFailOver | 应用容灾准备 | 应用容灾切换准备，初始化容灾切换任务。 |
其他
|
API |
标题 |
API概述 |
| ExecuteTask | 执行任务 | 创建任务 |
| ChangeResourceGroup | 更换应用或模板资源组 | 该接口可以将CADT创建的应用或模板从一个资源组转移到另一个资源组。 |
| CreateApplication | 基于模板创建应用接口 | 请确保在使用该接口前，已充分了解阿里云产品的收费方式和价格。基于CADT上官方模板或私有模板创建新的应用。 |
| CreateTask | 创建任务 | 创建任务 |
| DeleteApplication | 删除应用 | 删除应用。 |
| GetApplication | 获取应用详情 | 获取指定应用的基本信息、校验结果、计费结果、部署结果。 |
| GetTask | 获取Task信息 | 获取Task信息。 |
| GetTemplate | 获取模板信息 | 获取模板图片及架构图相关信息。 |
| GetToken | 获取加载架构图token（不推荐使用） | 获取读取架构图的临时授权，有效期30分钟。 |
| ListOperations | 查看某服务支持的操作 | 查看某服务支持的操作 |
| ListServices | 查看支持的服务列表 | 查看支持的服务列表 |
| ListTagResources | 查询标签接口 | 该接口用于查询应用或模板的标签。 |
| ListTemplate | 查询模板列表 | 获取模板列表，包括模板名称、架构图地址、架构图序列化文件地址等。 |
该文章对您有帮助吗？