文档

API概览

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

API目录

API标题API概述
ListServiceCategories查询服务类别名称

服务

API标题API概述
GetServiceTemplateParameterConstraints查询服务模板参数限定值通过模板名称、服务 ID查询指定地域下的ROS模板参数限定值。
GetServiceEstimateCost查询创建服务实例的预估价格查询创建服务实例的预估价格。
GenerateServicePolicy查询服务权限策略创建服务实例前查询缺少的权限策略。
GetServiceProvisions获取服务开通状态和服务角色等预置信息获取服务开通状态、服务角色等预置信息。

服务实例

API标题API概述
CreateServiceInstance创建并部署服务实例通过配置地域ID、服务实例名称、服务 ID等参数,在计算巢中创建并部署服务实例。
GetServiceInstance查询服务实例的详细信息通过地域ID、服务实例iD或者云市场实例ID、查询服务实例的详细信息,例如服务状态、模板名称、资源列表等信息。
ContinueDeployServiceInstance继续部署服务实例服务实例部署失败后,调用ContinueDeployServiceInstance继续部署该服务实例。
DeleteServiceInstances删除服务实例通过地域ID、服务实例ID,精确删除对应的服务实例。
ListServiceInstanceLogs查询服务实例的部署和升级日志通过地域 ID、服务实例 ID等参数查询服务实例的部署和升级日志。
ListServiceInstanceResources查询服务实例包含的资源通过服务实例 ID、资源 ARN(Aliyun Resource Name)、地域 ID等参数,查询满足条件服务实例资源列表。
ListServiceInstances查询服务实例列表通过地域 ID,资源ID等参数,查询当前账号在某地域下所有服务实例列表。
StartServiceInstance启动服务实例当服务实例状态为Stopped(已关机)、StartFailed(开机失败)时,调用StartServiceInstance接口启动服务实例。
StopServiceInstance关闭服务实例当服务实例状态为Deployed(已部署)、StopFailed(关机失败)时,调用StopServiceInstance接口关闭服务实例。
RestartServiceInstance重启服务实例当服务实例状态为Deployed(已部署)时,调用RestartServiceInstance接口重启服务实例。
UpdateServiceInstanceSpec变配服务实例当服务实例的参数值或套餐设置不满足您的要求时,调用UpdateServiceInstanceSpec对服务实例执行变配操作。

标签和资源组

API标题API概述
ListTagKeys查询已有标签键信息查询已有标签键信息。
UnTagResources删除标签调用UntagResources为指定的资源列表统一解绑标签。
TagResources创建并绑定标签调用TagResources为资源列表统一创建并绑定标签。
ListTagValues查询标签键对应的标签值查询标签键对应的标签值。
ChangeResourceGroup更改资源组通过云资源的资源 ID修改云资源所属的资源组。

服务使用申请

API标题API概述
ListServiceUsages查看当前服务使用申请查看用户自己当前的服务使用申请。
CancelServiceUsage取消服务使用申请当前用户取消对某个服务的使用申请。
CreateServiceUsage创建服务使用申请创建使用服务的申请。
UpdateServiceUsage更新使用服务申请用户更新使用服务申请。