API概览
ServiceStage API为开发者、合作伙伴提供开发、部署、托管、运维的开放接口，帮助用户快速、低成本地实现业务创新，缩短应用上线周期。
对应的接口参考请参考下表：
|
类型 |
子类型 |
说明 |
|---|---|---|
|
应用管理接口 |
应用模板、运行时、应用资源规格相关的接口。 |
|
|
应用环境相关的接口。 |
||
|
应用相关的接口。 |
||
|
应用组件相关的接口。 |
||
|
应用组件实例相关的接口。 |
||
|
Job相关的接口。 |
||
|
访问Git仓库接口 |
Git仓库授权、仓库命名空间、项目、分支、tags、commits、hooks、仓库文件目录、内容相关的接口。 |
|
|
CSE接口 |
微服务引擎相关的接口。 |
环境接口
|
API |
说明 |
|---|---|
|
此API用来创建环境。 |
|
|
此API用来获取所有已经创建环境。 |
|
|
此API通过环境ID修改环境信息。 |
|
|
此API通过环境ID删除环境。 |
|
|
此API通过环境ID获取环境详细信息。 |
|
|
此API用来修改环境资源。 |
应用接口
|
API |
说明 |
|---|---|
|
此API用来创建应用。 |
|
|
通过此API可以获取所有已经创建的应用。 |
|
|
此API通过应用ID修改应用信息。 |
|
|
此API通过应用ID删除应用。 |
|
|
此API通过应用ID获取应用详细信息。 |
|
|
通过此API添加或修改应用配置信息。 |
|
|
通过此API删除应用配置信息。 |
|
|
通过此API获取应用配置信息。 |
组件接口
|
API |
说明 |
|---|---|
|
此API用来在应用中创建组件。 |
|
|
通过此API获取应用下所有应用组件。 |
|
|
此API通过组件ID修改组件信息。 |
|
|
此API通过应用组件ID删除应用组件。 |
|
|
通过组件ID获取应用组件信息。 |
访问Git仓库接口
|
API |
说明 |
|---|---|
|
获取Git仓库所有授权信息。 |
|
|
获取授权重定向URL。 |
|
|
创建OAuth授权。 |
|
|
创建私有令牌授权。 |
|
|
创建Git仓库口令授权。 |
|
|
通过名称删除仓库授权。 |
|
|
获取仓库namespaces。 |
|
|
通过clone url获取仓库信息。 |
|
|
获取命名空间下所有项目。 |
|
|
创建软件仓库项目。 |
|
|
获取项目分支。 |
|
|
获取项目tags。 |
|
|
创建项目tags。 |
|
|
删除项目tags。 |
|
|
获取项目最近10次commits。 |
|
|
获取项目hooks。 |
|
|
创建项目hook。 |
|
|
删除项目hook。 |
|
|
获取仓库文件目录。 |
|
|
获取仓库文件内容。 |
|
|
创建仓库文件。 |
|
|
修改仓库文件内容。 |
|
|
删除仓库文件内容。 |
CSE接口
|
API |
说明 |
|---|---|
|
根据serviceId查询微服务定义信息。 |
|
|
根据条件组合，查询满足所有条件的微服务定义信息。 |
|
|
在注册微服务实例前需要创建服务静态信息，之后注册的微服务实例根据serviceId这个字段与静态信息关联，一个服务对应对多个实例。 serviceId可以定制。如果定制了，系统将使用定制的serviceId；如果没定制，系统会随机生成serviceId。 |
|
|
创建微服务静态信息后可对服务部分字段进行更新，每次更新都需要传入完整的服务静态信息json，也就是说，即便不更新部分的字段也要作为json的属性传过去。 |
|
|
根据指定的serviceId和schemaId查询微服务的schema信息。 |
|
|
根据schemaId更新微服务的访问契约内容。 |
|
|
创建服务间的依赖关系，consumer的version必须是确定的版本，consumer的serviceName不能为*，consumer必须是已存在的服务。provider可以是还未创建的。 |
|
|
根据consumerId获取该服务的所有providers。 |
|
|
可通过指定条件，查询微服务serviceId或schema的唯一标识信息。 |
|
|
创建微服务后就可以注册该微服务的实例了。 注册微服务实例时，需提供该微服务实例相关的信息。 instanceID可定制，如果定制了，再次注册就直接将全内容覆盖。如果没定制，逻辑如下：系统自动生成id，如果endpoints内容重复，则使用原来的id。 |
|
|
实例注册后可以根据service_id发现该微服务的所有实例。 |
|
|
实例注册后可以根据instance_id进行实例注销。 |
|
|
实例注册后可以根据serviceid和instanceId获取该实例的详细信息。 |
|
|
实例注册后可以根据instance_id进行添加/更新一个微服务实例扩展信息。 |
|
|
实例注册后可以根据instance_id进行更新一个微服务实例状态。 |
|
|
服务提供端需要向服务中心发送心跳信息，以保证服务中心知道服务实例是否健康。 |
|
|
实例注册后可以根据微服务版本规则或字段条件发现该微服务的实例。 |
|
|
从配置管理中心查询配置信息。 |
|
|
删除一个微服务定义及其相关信息，同时注销其所有实例信息。 |
|
|
批量删除指定的微服务定义及其相关信息，同时注销其所有实例信息。 |
|
|
实例注册后可以根据微服务版本规则或字段条件批量发现多个微服务的实例。 |
|
|
查询一个微服务的所有契约信息，包括schemaId和summary信息。 |
