API概览

更新时间：2023-06-26 GMT+08:00

ServiceStage API为开发者、合作伙伴提供开发、部署、托管、运维的开放接口，帮助用户快速、低成本地实现业务创新，缩短应用上线周期。

对应的接口参考请参考下表：

表1 接口简介
类型	子类型	说明
应用管理接口	Meta接口	应用模板、运行时、应用资源规格相关的接口。
	环境接口	应用环境相关的接口。
	应用接口	应用相关的接口。
	组件接口	应用组件相关的接口。
	实例接口	应用组件实例相关的接口。
	Job接口	Job相关的接口。
CSE接口	CSE接口	微服务引擎相关的接口。

Meta接口

表2 Meta接口介绍
API	说明
获取所有支持的应用组件运行时类型	此API用来获取所有支持应用组件运行时类型。
获取所有支持的应用资源规格	通过此API获取所用支持的应用资源规格。

环境接口

表3 环境接口介绍
API	说明
创建环境	此API用来创建环境。
获取所有环境	此API用来获取所有已经创建环境。
修改环境信息	此API通过环境ID修改环境信息。
根据环境ID删除环境	此API通过环境ID删除环境。
根据环境ID获取环境详细信息	此API通过环境ID获取环境详细信息。
修改环境资源	此API用来修改环境资源。

应用接口

表4 应用接口介绍
API	说明
创建应用	此API用来创建应用。
获取所有应用	通过此API可以获取所有已经创建的应用。
修改应用信息	此API通过应用ID修改应用信息。
根据应用ID删除应用	此API通过应用ID删除应用。
根据应用ID获取应用详细信息	此API通过应用ID获取应用详细信息。
添加或修改应用配置信息	通过此API添加或修改应用配置信息。
删除应用配置	通过此API删除应用配置信息。
获取应用配置	通过此API获取应用配置信息。

组件接口

表5 组件接口介绍
API	说明
应用中创建组件	此API用来在应用中创建组件。
获取应用所有组件	通过此API获取应用下所有应用组件。
根据组件ID修改组件信息	此API通过组件ID修改组件信息。
根据应用组件ID删除应用组件	此API通过应用组件ID删除应用组件。
根据组件ID获取应用组件信息	通过组件ID获取应用组件信息。

实例接口

表6 实例接口介绍
API	说明
创建组件实例	此API用来创建应用组件实例。
获取应用组件实例	通过此API获取组件下的所有组件实例。
对组件实例的操作	通过此API执行对组件实例的操作。
修改应用组件实例	通过此API修改应用组件实例。
删除应用组件实例	通过此API删除应用组件实例。
根据实例ID获取实例详细信息	此API通过实例ID获取实例详细信息。
获取组件实例快照	通过此API获取应用组件实例快照信息。

Job接口

表7 Job接口介绍
API	说明
获取部署任务详细信息	通过此API获取部署任务详细信息。

CSE接口

表8 CSE接口介绍
API	说明
查询指定微服务静态信息	根据serviceId查询微服务定义信息。
查询所有微服务静态信息	根据条件组合，查询满足所有条件的微服务定义信息。
创建微服务静态信息	在注册微服务实例前需要创建服务静态信息，之后注册的微服务实例根据serviceId这个字段与静态信息关联，一个服务对应对多个实例。 serviceId可以定制。如果定制了，系统将使用定制的serviceId；如果没定制，系统会随机生成serviceId。
修改微服务静态信息	创建微服务静态信息后可对服务部分字段进行更新，每次更新都需要传入完整的服务静态信息json，也就是说，即便不更新部分的字段也要作为json的属性传过去。
查询微服务访问契约	根据指定的serviceId和schemaId查询微服务的schema信息。
修改微服务访问契约	根据schemaId更新微服务的访问契约内容。
创建服务间依赖关系	创建服务间的依赖关系，consumer的version必须是确定的版本，consumer的serviceName不能为*，consumer必须是已存在的服务。provider可以是还未创建的。
查询服务providers	根据consumerId获取该服务的所有providers。
查询微服务唯一标识信息	可通过指定条件，查询微服务serviceId或schema的唯一标识信息。
注册微服务实例	创建微服务后就可以注册该微服务的实例了。注册微服务实例时，需提供该微服务实例相关的信息。 instanceID可定制，如果定制了，再次注册就直接将全内容覆盖。如果没定制，逻辑如下：系统自动生成id，如果endpoints内容重复，则使用原来的id。
查询微服务实例（根据serviceId）	实例注册后可以根据service_id发现该微服务的所有实例。
注销微服务实例	实例注册后可以根据instance_id进行实例注销。
查询微服务实例详细信息	实例注册后可以根据serviceid和instanceId获取该实例的详细信息。
修改微服务实例扩展信息	实例注册后可以根据instance_id进行添加/更新一个微服务实例扩展信息。
修改微服务实例状态	实例注册后可以根据instance_id进行更新一个微服务实例状态。
发送心跳信息	服务提供端需要向服务中心发送心跳信息，以保证服务中心知道服务实例是否健康。
按条件查询微服务实例	实例注册后可以根据微服务版本规则或字段条件发现该微服务的实例。
查询配置	从配置管理中心查询配置信息。
删除微服务信息	删除一个微服务定义及其相关信息，同时注销其所有实例信息。
批量删除微服务静态信息	批量删除指定的微服务定义及其相关信息，同时注销其所有实例信息。
批量查询微服务实例	实例注册后可以根据微服务版本规则或字段条件批量发现多个微服务的实例。
查询微服务的所有契约	查询一个微服务的所有契约信息，包括schemaId和summary信息。

上一篇：基本概念

下一篇：如何调用API

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消