同样在我的凭证下,您可以查看项目ID。
2 API 概览
微服务引擎API为开发者、合作伙伴提供微服务开发的开放接口,帮助用户快速、低成 本地实现业务上云,使能微服务应用的高效运行。
对应的接口参考请参考下表:
表2-1 接口简介
类型 子类型 说明
ServiceComb原 生接口
认证
提供微服务身份认证功能的相关操作接口。微服务
提供微服务管理的相关操作接口。契约
提供微服务契约查询、上传等相关操作接口。
微服务实例
提供微服务实例注册、上报心跳等相关操作接口。
依赖关系
提供微服务依赖关系查询接口。配置管理
提供配置中心配置管理功能的相关操作接口。
认证
表2-2 认证接口
API 说明
获取微服务引擎专享版用户Token
仅用于开启了安全认证的微服务引擎专享版。
在访问开启了安全认证的微服务引擎专享 版的接口前,需要先调用该接口获取用户 Token,该Token是访问接口的唯一凭据。
微服务
表2-3 微服务接口
API 说明
查询指定微服务信息
根据serviceId查询微服务定义信息。删除微服务定义信息
删除一个微服务定义及其相关信息,同时注销其所有实例信息。
查询所有微服务信息
根据条件组合,查询满足所有条件的微服务定义信息。
创建微服务静态信息
在注册微服务实例前需要创建服务静态信息,之后注册的微服务实例根据service_id 这个字段与静态信息关联,一个服务对应 对多个实例。service_id可以定制。如果定 制了,系统将使用定制的service_id;如果 没定制,系统会随机生成service_id。
批量删除微服务静态信息
批量删除指定的微服务定义及其相关信息,同时注销其所有实例信息。
修改微服扩展属性信息
创建微服务静态信息后可对服务部分字段进行更新,每次更新都需要传入完整的服 务静态信息json,也就是说,即便不更新 部分的字段也要作为json的属性传过去。
查询微服务唯一标识信息
可通过指定条件,查询微服务service_id或schema的唯一标识信息。
契约
表2-4 契约接口
API 说明
查询微服务契约
根据service_id和schema_id查询微服务的契约信息。
修改微服务契约
根据schema_id更新微服务的契约内容。查询微服务的所有契约
查询一个微服务的所有契约信息,包括schema_id和summary信息。
微服务实例
表2-5 微服务实例接口
API 说明
注册微服务实例
创建微服务后就可以注册该微服务的实例了。 注册微服务实例时,需提供该微 服务实例相关的信息。 instance_id可定 制,如果定制了,再次注册就直接全内 容覆盖。如果没定制,逻辑如下:系统 自动生成id,如果endpoints内容重复,
则使用原来的id。
根据service_id查询微服务实例
实例注册后可以根据service_id发现该微服务的所有实例。
注销微服务实例
实例注册后可以根据instance_id进行实例注销。
查询微服务实例详细信息
实例注册后可以根据service_id和instance_id获取该实例的详细信息。
修改微服务实例扩展信息
实例注册后可以根据instance_id进行添加/更新一个微服务实例扩展信息。
修改微服务实例状态
实例注册后可以根据instance_id进行更新一个微服务实例状态。
查询服务providers
根据consumer_id获取该服务的所有providers,比如A->B A->C,那么根据A的 服务Id,可以查询到B、C的微服务信 息。
配置管理
表2-7 配置管理接口
API 说明