文档首页 > > API参考> API概览

API概览

分享
更新时间:2020/06/19 GMT+08:00

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

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

表1 接口简介

类型

子类型

说明

应用管理接口

请使用如下endpoint:

servicestage.<regionname>.myhuaweicloud.com

Mate接口

应用模板、运行时、应用资源规格相关的接口。

环境接口

应用环境相关的接口。

应用接口

应用相关的接口。

组件接口

应用组件相关的接口。

实例接口

应用组件实例相关的接口。

Job接口

Job相关的接口。

访问Git仓库接口

请使用如下endpoint:

servicestage.<regionname>.myhuaweicloud.com

访问Git仓库接口

Git仓库授权、仓库命名空间、项目、分支、tags、commits、hooks、仓库文件目录、内容相关的接口。

CSE接口

请使用如下endpoint:

cse.<regionname>.myhuaweicloud.com

微服务接口

微服务相关的接口。

契约接口

契约相关的接口。

依赖关系接口

依赖关系相关的接口

微服务实例接口

微服务实例相关的接口

动态配置接口

动态配置相关的接口

仪表盘接口

仪表盘相关的接口

Mate接口

表2 Mate接口介绍

API

说明

获取所有支持的应用组件模板

此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获取部署任务详细信息。

访问Git仓库接口

表8 访问Git仓库接口介绍

API

说明

获取仓库授权列表

获取Git仓库所有授权信息。

获取授权重定向URL

获取授权重定向URL。

创建OAuth授权

创建OAuth授权。

创建私人令牌授权

创建私有令牌授权。

创建口令授权

创建Git仓库口令授权。

删除仓库授权

通过名称删除仓库授权。

获取仓库namespaces

获取仓库namespaces。

通过clone url 获取仓库信息

通过clone url获取仓库信息。

获取命名空间下所有项目

获取命名空间下所有项目。

创建软件仓库项目

创建软件仓库项目。

获取项目分支

获取项目分支。

获取项目tags

获取项目tags。

创建项目tags

创建项目tags。

删除项目tags

删除项目tags。

获取项目commits

获取项目最近10次commits。

获取项目hooks

获取项目hooks。

创建项目hook

创建项目hook。

删除项目hook

删除项目hook。

获取仓库文件目录

获取仓库文件目录。

获取仓库文件内容

获取仓库文件内容。

创建仓库文件

创建仓库文件。

修改仓库文件内容

修改仓库文件内容。

删除仓库文件

删除仓库文件内容。

微服务接口

表9 微服务接口

API

说明

查询指定微服务信息

根据serviceId查询微服务定义信息。

删除微服务定义信息

删除一个微服务定义及其相关信息,同时注销其所有实例信息。

查询所有微服务信息

根据条件组合,查询满足所有条件的微服务定义信息。

创建微服务静态信息

在注册微服务实例前需要创建服务静态信息,之后注册的微服务实例根据service_id这个字段与静态信息关联,一个服务对应对多个实例。service_id可以定制。如果定制了,系统将使用定制的service_id;如果没定制,系统会随机生成service_id。

批量删除微服务静态信息

批量删除指定的微服务定义及其相关信息,同时注销其所有实例信息。

修改微服扩展属性信息

创建微服务静态信息后可对服务部分字段进行更新,每次更新都需要传入完整的服务静态信息json,也就是说,即便不更新部分的字段也要作为json的属性传过去。

查询微服务唯一标识信息

可通过指定条件,查询微服务service_id或schema的唯一标识信息。

契约接口

表10 契约接口

API

说明

查询微服务契约

根据service_id和schema_id查询微服务的契约信息。

修改微服务契约

根据schema_id更新微服务的契约内容。

查询微服务的所有契约

查询一个微服务的所有契约信息,包括schema_id和summary信息。

依赖关系接口

表11 依赖关系接口

API

说明

创建服务间依赖关系

创建服务间的依赖关系,consumer的version必须是确定的版本,consumer的serviceName不能为*,consumer必须是已存在的服务。provider可以是还未创建的。

查询服务providers

根据consumer_id获取该服务的所有providers,比如A->B A->C,那么根据A的服务Id,可以查询到B、C的微服务信息。

微服务实例接口

表12 微服务实例接口

API

说明

注册微服务实例

创建微服务后就可以注册该微服务的实例了。 注册微服务实例时,需提供该微服务实例相关的信息。 instance_id可定制,如果定制了,再次注册就直接全内容覆盖。如果没定制,逻辑如下:系统自动生成id,如果endpoints内容重复,则使用原来的id

根据service_id查询微服务实例

实例注册后可以根据 service_id 发现该微服务的所有实例。

注销微服务实例

实例注册后可以根据 instance_id 进行实例注销。

查询微服务实例详细信息

实例注册后可以根据service_id和instance_id获取该实例的详细信息。

修改微服务实例扩展信息

实例注册后可以根据 instance_id 进行添加/更新一个微服务实例扩展信息。

修改微服务实例状态

实例注册后可以根据 instance_id 进行更新一个微服务实例状态。

发送心跳信息

服务提供端需要向服务中心发送心跳信息,以保证服务中心知道服务实例是否健康。

按条件查询微服务实例

实例注册后可以根据微服务版本规则或字段条件发现该微服务的实例。

批量查询微服务实例

实例注册后可以根据微服务版本规则或字段条件批量发现多个微服务的实例。

动态配置接口

表13

API

说明

查询配置

从配置管理中心查询配置信息

仪表盘接口

表14

API

说明

创建上报服务指标

创建上报到仪表盘的服务指标。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问