API概览
|
类型 |
子类型 |
说明 |
|---|---|---|
|
应用管理API（v3版本） |
环境的相关接口。 环境是用于组件部署和运行的计算（如集群、弹性云服务器 ECS等）、网络（如弹性负载均衡 ELB、弹性IP EIP等）和中间件（如分布式缓存 DCS、云数据库 RDS等）等基础资源的集合。ServiceStage把多种基础资源组合为一个环境，如：开发环境、测试环境、预生产环境和生产环境。按环境维度来管理资源、创建部署组件，可以减少具体基础资源运维管理的复杂性。 |
|
|
应用的相关接口。 应用是一个功能相对完备的业务系统，由一个或多个特性相关的组件组成。 |
||
|
组件的相关接口。 组件是组成应用的某个业务特性实现，以代码或者软件包为载体，可独立部署在环境下运行。 |
||
|
配置的相关接口。 在ServiceStage中，配置就是一个文件。通过创建统一的配置文件，您可以将环境和应用的系统变量（例如环境关联的IP、端口、数据库地址，应用关联的应用名称等）填充到配置中，生成一个配置文件。组件关联配置文件进行部署时，系统变量会自动替换为实际值，通过文件挂载实现一次配置、多环境使用。 |
||
|
部署任务的相关接口。 |
||
|
管理插件的相关接口。 |
||
|
旧版发布管理和新版发布管理的相关接口。 |
||
|
技术栈管理和目录配置的相关接口。 |
||
|
访问Git仓库API |
Git仓库授权、仓库命名空间、项目、分支、tags、commits、hooks、仓库文件目录、内容的相关接口。 |
|
|
CSE API |
提供从配置管理中心导入、导出配置信息的接口。 |
|
|
提供创建、查询、删除微服务引擎专享版的引擎管理接口。 |
||
|
ServiceComb API |
微服务身份认证功能的相关操作接口。 |
|
|
微服务管理的相关操作接口。 |
||
|
微服务契约查询、上传等相关操作接口。 |
||
|
微服务实例注册、上报心跳等相关操作接口。 |
||
|
微服务依赖关系查询接口。 |
||
|
提供配置中心配置管理功能的相关操作接口。 |
环境接口
|
API |
说明 |
|---|---|
|
此API用来创建环境。 |
|
|
此API用来获取所有环境。 |
|
|
此API用来通过环境ID删除环境。 |
|
|
此API用来通过环境ID修改环境。 |
|
|
根据环境ID获取环境详细信息 - ObtainEnvironmentDetailsBasedOnTheEnvironmentID |
此API用来通过环境ID获取环境详细信息。 |
|
根据环境ID修改环境资源 - ModifyEnvironmentResourceBasedOnTheEnvironmentID |
此API用来通过环境ID修改环境资源。 |
|
根据环境ID查询环境纳管的资源 - QueryManagedResourceBasedOnTheEnvironmentID |
此API用来根据环境ID查询环境纳管的资源。 |
|
此API用来根据类型获取环境可纳管的资源。 |
|
|
此API用来根据环境ID刷新环境。 |
应用接口
|
API |
说明 |
|---|---|
|
此API用来创建应用。 |
|
|
此API用来获取所有应用。 |
|
|
根据应用ID修改应用信息 - ModifyApplicationInformationBasedOnTheApplicationID |
此API用来通过应用ID修改应用信息。 |
|
此API用来通过应用ID删除应用。 |
|
|
根据应用ID获取应用详细信息 - ObtainApplicationDetailsBasedOnTheApplicationID |
此API用来通过应用ID获取应用详细信息。 |
|
根据应用ID获取应用配置 - ObtainApplicationConfigurationsBasedOnTheApplicationID |
此API用来通过应用ID获取应用配置信息。 |
|
根据应用ID修改应用配置 - ModifyApplicationConfigurationsBasedOnTheApplicationID |
此API用来通过应用ID修改应用配置。 |
|
根据应用ID删除应用配置 - DeleteApplicationConfigurationsBasedOnTheApplicationID |
此API用来通过应用ID删除应用配置。 |
|
根据应用ID批量操作组件 - PerformOperationsOnComponentsBasedOnTheApplicationID |
此API用来根据应用ID批量操作组件。 |
组件接口
|
API |
说明 |
|---|---|
|
此API用来在应用中创建组件。 |
|
|
应用中导入CCE工作负载创建组件 - ImportCCEWorkloadToAnApplicationToCreateComponent |
此API用来在应用中导入CCE工作负载创建组件。 |
|
此API用来获取应用下所有组件。 |
|
|
此API用来获取所有应用组件。 |
|
|
根据组件ID修改组件信息 - ModifyComponentInformationBasedOnTheComponentID |
此API用来通过组件ID修改组件信息。 |
|
此API用来通过组件ID删除组件。 |
|
|
根据组件ID获取组件信息 - ObtainComponentInformationBasedOnTheComponentID |
此API用来通过组件ID获取组件信息。 |
|
此API用来通过组件ID下发组件任务。 |
|
|
此API用来通过组件ID获取记录。 |
|
|
根据组件ID刷新组件信息 - RefreshComponentInformationBasedOnTheComponentID |
此API用来通过组件ID刷新组件状态和访问方式信息。 |
|
此API用来获取所有组件所属的应用信息、环境信息、企业项目信息。 |
|
|
此API用来通过组件ID批量下发组件任务。 |
|
|
此API用来基于组件模板创建组件。 |
|
|
此API用来解析组件模板包。 |
配置管理接口
|
API |
说明 |
|---|---|
|
此API用来创建配置分组，用于对配置文件分类管理。 |
|
|
此API用来获取所有已经创建的配置分组。 |
|
|
此API用来创建配置文件。 |
|
|
此API通过导入zip压缩包创建配置文件。 |
|
|
此API用来获取配置文件信息。 |
|
|
根据配置文件ID获取配置文件信息 - ObtainConfigurationFileInformationBasedOnTheConfigurationFileID |
此API通过配置文件ID获取配置文件的详情。 |
|
根据配置文件ID删除配置文件 - DeleteConfigurationFileBasedOnTheConfigurationFileID |
此API通过配置文件ID删除配置文件。 |
|
根据配置文件ID修改配置文件 - ModifyConfigurationFileBasedOnTheConfigurationFileID |
此API通过配置文件ID修改配置文件。 |
|
根据配置文件ID获取配置文件历史 - ObtainConfigurationFileHistoryBasedOnTheConfigurationFileID |
此API通过配置文件ID获取配置文件历史。 |
|
根据配置文件历史ID获取配置文件历史信息 - ObtainConfigurationFileHistoryInformationBasedOnTheHistoryID |
此API通过配置文件历史ID获取配置文件历史信息。 |
|
根据配置文件历史ID删除配置文件历史 - DeleteConfigurationFileHistoryBasedOnTheHistoryID |
此API通过配置文件历史ID删除配置文件历史。 |
|
根据配置分组ID获取分组详情 - ObtainConfigurationGroupDetailsBasedOnTheGroupID |
此API通过配置分组ID获取配置分组详情。 |
|
此API根据配置分组ID删除分组。 |
插件管理接口
|
API |
说明 |
|---|---|
|
此API用来创建插件。 |
|
|
此API用来查询环境下的插件列表。 |
|
|
此API用来查询环境下插件的元数据信息。 |
|
|
此API用来查询环境下指定插件详情。 |
|
|
此API用来根据插件ID下发插件任务。 |
|
|
此API用于根据插件ID删除插件。 |
发布管理接口
|
API |
说明 |
|---|---|
|
此API用来创建发布单。 |
|
|
此API用来根据发布单ID编辑发布单。 |
|
|
此API用来根据发布单ID删除发布单。 |
|
|
此API用来获取发布单列表。 |
|
|
根据发布单ID获取发布单信息 - ObtainInformationAboutReleaseTaskBasedOnTheReleaseTaskID |
此API用来根据发布单ID获取发布单信息。 |
|
根据发布单ID获取发布单部署信息 - ObtainDeploymentInformationAboutReleaseTaskBasedOnTheReleaseTaskID |
此API用来根据发布单ID获取发布单部署信息。 |
|
此API用来根据发布单ID执行发布单。 |
|
|
此API用来根据发布单ID回滚发布单。 |
|
|
此API用来根据发布单ID中断发布单。 |
|
API |
说明 |
|---|---|
|
此API用来创建发布单。 |
|
|
此API用来获取发布单列表。 |
|
|
此API用来编辑发布单。 |
|
|
此API用来根据发布单ID操作发布单。 |
|
|
根据发布单ID查看发布单详情 - ViewReleaseTaskDetailsBasedOnTheReleaseTaskID |
此API用来根据发布单ID查看发布单详情。 |
|
根据发布单ID查看发布单执行记录 - ViewReleaseTaskExecutionRecordBasedOnTheReleaseTaskID |
此API用来根据发布单ID查看发布单执行记录。 |
|
此API用来根据发布单ID创建触发策略。 |
|
|
此API用来根据发布单ID修改触发策略。 |
|
|
此API用来根据发布单ID查询触发策略。 |
|
|
此API用来解析发布单模板包。 |
系统配置接口
|
API |
说明 |
|---|---|
|
此API用来查询技术栈信息。 |
|
|
此API用来获取ServiceStage各个技术栈构建时使用的内置基础镜像。 |
|
|
此API用来创建自定义技术栈。 |
|
|
根据技术栈ID查询技术栈 - QueryTechnologyStackBasedOnTheTechnologyStackID |
此API用来根据技术栈ID查询技术栈。 |
|
根据技术栈ID修改技术栈 - ModifyTechnologyStackBasedOnTheTechnologyStackID |
此API用来根据技术栈ID修改技术栈。 |
|
根据技术栈ID删除技术栈 - DeleteTechnologyStackBasedOnTheTechnologyStackID |
此API用来根据技术栈ID删除技术栈。 |
|
此API用来发布和取消发布技术栈。 |
|
API |
说明 |
|---|---|
|
此API用于创建自定义目录配置。 |
|
|
此API用于查询目录配置信息。 |
|
|
根据目录配置ID查询目录配置 - QueryDirectorySettingsBasedOnTheDirectorySettingID |
此API用于根据目录配置ID查询目录配置。 |
|
根据目录配置ID修改目录配置 - ModifyDirectorySettingsBasedOnTheDirectorySettingID |
此API用于根据目录配置ID修改目录配置。 |
|
根据目录配置ID删除目录配置 - DeleteDirectorySettingsBasedOnTheDirectorySettingID |
此API用于根据目录配置ID删除目录配置。 |
访问Git仓库接口
|
API |
说明 |
|---|---|
|
此API用于获取Git仓库所有授权信息。 |
|
|
此API用于获取授权重定向URL。 |
|
|
此API用于创建OAuth授权。 |
|
|
此API用于创建私有令牌授权。 |
|
|
此API用于创建Git仓库口令授权。 |
|
|
此API用于通过名称删除仓库授权。 |
|
|
此API用于获取仓库namespaces。 |
|
|
通过clone URL获取仓库信息 - ObtainRepositoryInformationBasedOnTheCloneURL |
此API用于通过clone URL获取仓库信息。 |
|
此API用于获取命名空间下所有项目。 |
|
|
此API用于创建软件仓库项目。 |
|
|
此API用于获取项目分支。 |
|
|
此API用于获取项目tags。 |
|
|
此API用于创建项目tags。 |
|
|
此API用于删除项目tags。 |
|
|
此API用于获取项目最近10次commits。 |
|
|
此API用于获取项目hooks。 |
|
|
此API用于创建项目hook。 |
|
|
此API用于删除项目hook。 |
|
|
此API用于获取仓库文件目录。 |
|
|
此API用于获取仓库文件内容。 |
|
|
此API用于创建仓库文件。 |
|
|
此API用于修改仓库文件内容。 |
|
|
此API用于删除仓库文件内容。 |
|
|
此API用于根据参考授权信息校验当前的密码是否正确。 |
引擎管理
|
API |
说明 |
|---|---|
|
此API用于查询微服务引擎专享版支持的规格。 |
|
|
此API用于查询微服务引擎专享版列表。 |
|
|
此API用于创建微服务引擎专享版。 |
|
|
此API用于查询微服务引擎专享版详情。 |
|
|
此API用于删除微服务引擎专享版。 |
|
|
此API用于查询微服务引擎专享版任务详情。 |
认证
|
API |
说明 |
|---|---|
|
获取微服务引擎专享版用户Token - ObtainUserTokenOfExclusiveMicroserviceEngine |
此API仅用于开启了安全认证的微服务引擎专享版。 在访问开启了安全认证的微服务引擎专享版的接口前，需要先调用该接口获取用户Token，该Token是访问接口的唯一凭据。 |
微服务
|
API |
说明 |
|---|---|
|
此API用于根据serviceId查询微服务定义信息。 |
|
|
此API用于删除一个微服务定义及其相关信息，同时注销其所有实例信息。 |
|
|
此API用于根据条件组合，查询满足所有条件的微服务定义信息。 |
|
|
此API用于在注册微服务实例前创建服务静态信息，之后注册的微服务实例根据serviceId这个字段与静态信息关联，一个服务对应对多个实例。serviceId可以定制。如果定制了，系统将使用定制的serviceId；如果没定制，系统会随机生成serviceId。 |
|
|
批量删除微服务静态信息 - DeleteStaticInformationAboutMicroservicesInBatches |
此API用于批量删除指定的微服务定义及其相关信息，同时注销其所有实例信息。 |
|
此API用于创建微服务静态信息后对服务部分字段进行更新。每次更新都需要传入完整的服务静态信息json，也就是说，即便不更新部分的字段也要作为json的属性传过去。 |
|
|
此API用于通过指定条件，查询微服务serviceId或schema的唯一标识信息。 |
契约
|
API |
说明 |
|---|---|
|
此API用于根据service_id和schema_id查询微服务的契约信息。 |
|
|
此API用于根据schema_id更新微服务的契约内容。 |
|
|
此API用于查询一个微服务的所有契约信息，包括schemaId和summary信息。 |
微服务实例
|
API |
说明 |
|---|---|
|
此API用于在创建微服务后注册该微服务的实例。 注册微服务实例时，需提供该微服务实例相关的信息。 instanceId可定制，如果定制了，再次注册就直接全内容覆盖。如果没定制，逻辑如下：系统自动生成id，如果endpoints内容重复，则使用原来的id。 |
|
|
此API用于在实例注册后根据service_id发现该微服务的所有实例。 |
|
|
此API用于在实例注册后根据instance_id进行实例注销。 |
|
|
此API用于在实例注册后根据service_id和instance_id获取该实例的详细信息。 |
|
|
修改微服务实例扩展信息 - ModifyExtendedInformationAboutMicroserviceInstance |
此API用于在实例注册后根据instance_id添加/更新一个微服务实例的扩展信息。 |
|
此API用于在实例注册后根据instance_id更新一个微服务实例的状态。 |
|
|
此API用于在服务提供端向服务中心发送心跳信息，以保证服务中心知道服务实例是否健康。 |
|
|
此API用于在实例注册后根据微服务版本规则或字段条件发现该微服务的实例。 |
|
|
此API用于在实例注册后根据微服务版本规则或字段条件批量发现多个微服务的实例。 |
