API概览

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

Token

API标题API概述
GetToken获取加载架构图token(不推荐使用)获取读取架构图的临时授权,有效期30分钟。

模板

API标题API概述
GetTemplate获取模板信息获取模板图片及架构图相关信息。
ListTemplate查询模板列表获取模板列表,包括模板名称、架构图地址、架构图序列化文件地址等。
ValuateTemplate模板实时询价查询模板价格。

应用

API标题API概述
GetApplicationVariables获取应用输入参数获取一个应用的所有输入的模版变量的值。
ReConfigApplication更新应用属性用户可以从上面函数获取到需要重新配置的模版变量列表。然后对这些变量重新赋值后,调用本函数,应用状态会变为“修改中”,同时失败节点的属性值会根据传入的模版变量值重新赋值(例如:修改了失败资源的实例类型等)。执行该函数后,用户可以重新部署该应用。
GetApplicationVariables4Fail查询“部分部署成功”的应用中和部署失败的资源节点相关的模版变量列表获取需要重新配置的变量列表。
CreateApplication基于模板创建应用接口请确保在使用该接口前,已充分了解阿里云产品的收费方式和价格。基于CADT上官方模板或私有模板创建新的应用。
DeleteApplication删除应用删除应用。
GetApplication获取应用详情获取指定应用的基本信息、校验结果、计费结果、部署结果。
ListApplication获取应用列表该接口提供当前用户下所有应用的列表。其中可选参数keyword定义应用名中包含的关键字。
DeployApplication部署应用计费成功后,创建资源。
ReleaseApplication释放应用该接口释放应用的资源。
ValidateApplication应用校验对应用下的资源输入的合法性进行校验,异步执行,校验结果调用GetApplication获取。
ValuateApplication应用计费对应用下的资源进行询价,通过GetApplication获取询价结果。
GetResource4ModifyRecord获取询价应用变配记录获取询价应用变配记录。
GetResult4QueryInstancePrice4Modify获取询价结果获取询价结果。
ModifyApplicationSpec提交应用变配提交应用变配。
QueryInstancePrice4Modify查询变配价格查询变配价格。
QueryInstanceSpec4Modify查询变配规格列表查询变配规格列表。

资源组

API标题API概述
ChangeResourceGroup更换应用或模板资源组该接口可以将CADT创建的应用或模板从一个资源组转移到另一个资源组。

容灾服务

API标题API概述
GetPotentialFailZones获取容灾服务可切换的可用区列表获取指定容灾服务可切换的可用区列表。
GetFoTaskStatus获取指定容灾任务的状态获取指定容灾任务(TaskId)的状态。
AppFailOver容灾应用切换将容灾集切换至支持的可用区。
AppFailBack容灾应用切回将容灾集切回至主可用区。
ListFoCreatedApps查询所有容灾服务计划接口查询当前账户下所有容灾服务计划。
InitAppFailOver应用容灾准备应用容灾切换准备,初始化容灾切换任务。

其他接口

API标题API概述
ExecuteOperationSync同步执行操作维护应用下资源API(同步操作)
GetExecuteOperationResult异步获取操作结果异步获取操作结果。
ExecuteOperationASync异步执行操作异步执行产品操作功能。
ListTagResources查询标签接口该接口用于查询应用或模板的标签。