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

API概览

分享
更新时间: 2019/09/27 GMT+08:00

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

对应的接口参考请参考下表:
表1 接口简介

类型

子类型

说明

ServiceStage

应用管理

请使用如下endpoint:

servicestage.<regionname>.myhuaweicloud.com

应用服务实例的创建、修改、获取详情和删除等接口。

应用组创建、修改、获取详情和删除等接口。

应用设计的创建、查询、修改和操作等接口。

应用契约的创建、查询、修改和删除等接口。

访问Git仓库

请使用如下endpoint:

servicestage.<regionname>.myhuaweicloud.com

Git仓库授权创建、查询和删除等接口。

Git仓库命名空间、项目、分支、tags、commits、hookd等相关的操作接口。

Git仓库文件目录、内容等相关的操作接口。

微服务引擎

请使用如下endpoint:

cse.<regionname>.myhuaweicloud.com

服务管理中心的接口,包括查询、创建、修改、删除微服务的相关信息等内容的接口。

配置管理中心的接口,包括查询、创建、修改、删除配置项和校验规则的接口。

仪表盘的接口,包括上报事务数据、服务监控配置、活动事务信息、项目指标信息、健康检查等接口。

APM

应用性能管理 API

查询调用链系统中的监控组列表,用于调用链数据查询。

查询调用链系统中的应用列表,用于调用链数据查询。

查询指定应用下的实例列表。

查询指定应用下的业务列表。

根据调用链的traceId信息查询调用链详情。

应用管理接口

表2 应用管理接口介绍

API

说明

获取应用服务实例信息

通过project ID和instance ID获取应用服务实例的信息。

修改应用服务实例

此API用于修改应用服务实例信息如cpu 、内存、磁盘、缩放规则、源代码、软件或镜像包文件等。

创建应用服务实例

这个API用来创建应用服务的实例。

删除应用服务实例

此API用做删除应用服务的实例。

获取全部应用服务实例

此API用做获取全部应用服务实例。

获取应用服务任务详情

此API用做获取应用服务任务详情。

获取可支持的应用的类别

此API用做获取可支持的应用的类别。

获取可支持的应用实例的大小

此API用做获取可支持的应用实例的大小,如内存、CPU、存储空间等。

访问Git仓库接口

表3 访问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。

获取仓库文件目录

获取仓库文件目录。

获取仓库文件内容

获取仓库文件内容。

创建仓库文件

创建仓库文件。

修改仓库文件内容

修改仓库文件内容。

删除仓库文件

删除仓库文件内容。

微服务引擎接口

表4 微服务引擎接口介绍

API

说明

查询指定微服务信息

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

查询所有微服务信息

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

创建微服务静态信息

在注册微服务实例前需要创建服务静态信息,之后注册的微服务实例根据service id这个字段与静态信息关联,一个服务对应对多个实例。

Serviceid可以定制。如果定制了,系统将使用定制的Serviceid;如果没定制,系统会随机生成Serviceid。

修改微服务静态信息

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

查询微服务访问契约

根据指定的serviceId和schemaId查询微服务的schema信息。

修改微服务访问契约

根据schemaId更新微服务的访问契约内容。

创建服务间依赖关系

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

查询服务providers

根据consumerId获取该服务的所有providers。

查询微服务唯一标识信息

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

注册微服务实例

创建微服务后就可以注册该微服务的实例了。 注册微服务实例时,需提供该微服务实例相关的信息。

instanceID可定制,如果定制了,再次注册就直接将全内容覆盖。如果没定制,逻辑如下:系统自动生成id,如果endpoints内容重复,则使用原来的id。

查询微服务实例(根据service_id)

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

注销微服务实例

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

查询微服务实例详细信息

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

修改微服务实例扩展信息

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

修改微服务实例状态

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

发送心跳信息

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

按条件查询微服务实例

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

查询配置

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

创建上报服务指标

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

创建上报事务数据

事务数据上报。

删除微服务定义信息

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

批量删除微服务静态信息

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

批量查询微服务实例

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

查询微服务的所有契约

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

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区