华为云用户手册

引擎管理 表13 引擎管理接口 API 说明 查询微服务引擎专享版支持规格 此API用于查询微服务引擎专享版支持的规格。 查询微服务引擎专享版列表 此API用于查询微服务引擎专享版列表。 创建微服务引擎专享版 此API用于创建微服务引擎专享版。 查询微服务引擎专享版详情 此API用于查询微服务引擎专享版详情。 删除微服务引擎专享版 此API用于删除微服务引擎专享版。 查询微服务引擎专享版任务详情 此API用于查询微服务引擎专享版任务详情。

访问Git仓库接口 表11 访问Git仓库接口 API 说明 获取仓库授权列表 此API用于获取Git仓库所有授权信息。 获取授权重定向URL 此API用于获取授权重定向URL。 创建OAuth授权 此API用于创建OAuth授权。 创建私人令牌授权 此API用于创建私有令牌授权。 创建口令授权 此API用于创建Git仓库口令授权。 删除仓库授权 此API用于通过名称删除仓库授权。 获取仓库namespaces 此API用于获取仓库namespaces。 通过clone url获取仓库信息 此API用于通过clone url获取仓库信息。 获取命名空间下所有项目 此API用于获取命名空间下所有项目。 创建软件仓库项目 此API用于创建软件仓库项目。 获取项目分支 此API用于获取项目分支。 获取项目tags 此API用于获取项目tags。 创建项目tags 此API用于创建项目tags。 删除项目tags 此API用于删除项目tags。 获取项目commits 此API用于获取项目最近10次commits。 获取项目hooks 此API用于获取项目hooks。 创建项目hook 此API用于创建项目hook。 删除项目hook 此API用于删除项目hook。 获取仓库文件目录 此API用于获取仓库文件目录。 获取仓库文件内容 此API用于获取仓库文件内容。 创建仓库文件 此API用于创建仓库文件。 修改仓库文件内容 此API用于修改仓库文件内容。 删除仓库文件 此API用于删除仓库文件内容。

泳道组接口 表7 泳道组接口 API 说明 创建泳道组 此API用来在创建泳道组。 泳道组是一组泳道的集合，用于区分不同的组织或场景。同一个项目下，最多支持创建300个泳道组。 获取所有泳道组 此API用来获取所有已经创建的泳道组。 根据泳道组ID获取泳道组信息 此API用来根据泳道组ID获取泳道组信息。 根据泳道组ID修改泳道组 此API用来根据泳道组ID修改泳道组。 根据泳道组ID删除泳道组 此API用来根据泳道组ID删除泳道组。 根据网关ID获取目标服务列表 此API用来根据网关ID获取目标服务列表。 根据泳道组ID修改泳道组网关路由配置 此API用来根据泳道组ID修改泳道组网关路由配置。

泳道接口 表8 泳道接口 API 说明 泳道组下创建泳道 此API用来在泳道组下创建泳道。 根据微服务引擎ID获取所有泳道 此API用来根据微服务引擎ID获取所有泳道。 获取泳道组下所有泳道 此API用来获取泳道组下所有泳道。 根据泳道ID获取泳道信息 此API用来根据泳道ID获取泳道信息。 根据泳道ID修改泳道信息 此API用来根据泳道ID修改泳道信息。 根据泳道ID删除泳道 此API用来根据泳道ID删除泳道。 根据泳道ID控制泳道路由开关 此API用来根据泳道ID控制泳道路由开关。 根据泳道ID关联组件 此API用来根据泳道ID为泳道关联组件。

微服务 表15 微服务接口 API 说明 查询指定微服务信息 此API用于根据serviceId查询微服务定义信息。 删除微服务定义信息 此API用于删除一个微服务定义及其相关信息，同时注销其所有实例信息。 查询所有微服务信息 此API用于根据条件组合，查询满足所有条件的微服务定义信息。 创建微服务静态信息 此API用于在注册微服务实例前创建服务静态信息，之后注册的微服务实例根据serviceId这个字段与静态信息关联，一个服务对应对多个实例。serviceId可以定制。如果定制了，系统将使用定制的serviceId；如果没定制，系统会随机生成serviceId。 批量删除微服务静态信息 此API用于批量删除指定的微服务定义及其相关信息，同时注销其所有实例信息。 修改微服扩展属性信息 此API用于创建微服务静态信息后对服务部分字段进行更新。每次更新都需要传入完整的服务静态信息json，也就是说，即便不更新部分的字段也要作为json的属性传过去。 查询微服务唯一标识信息 此API用于通过指定条件，查询微服务serviceId或schema的唯一标识信息。

环境接口 表2 环境接口 API 说明 创建环境 此API用来创建环境。 获取所有环境 此API用来获取所有环境。 根据环境ID删除环境 此API用来通过环境ID删除环境。 根据环境ID修改环境 此API用来通过环境ID修改环境。 根据环境ID获取环境详细信息 此API用来通过环境ID获取环境详细信息。 根据环境ID修改环境资源 此API用来通过环境ID修改环境资源。 根据环境ID查询环境纳管的资源 此API用来根据环境ID查询环境纳管的资源。

组件接口 表4 组件接口 API 说明 应用中创建组件 此API用来在应用中创建组件。 获取应用所有组件 此API用来获取应用下所有组件。 获取所有组件 此API用来获取所有应用组件。 根据组件ID修改组件信息 此API用来通过组件ID修改组件信息。 根据组件ID删除组件 此API用来通过组件ID删除组件。 根据组件ID获取组件信息 此API用来通过组件ID获取组件信息。 根据组件ID下发组件任务 此API用来通过组件ID下发组件任务。 根据组件ID获取记录 此API用来通过组件ID获取记录。 根据组件ID刷新组件信息 此API用来通过组件ID刷新组件状态和访问方式信息。 获取组件相关配置信息 此API用来获取所有所有组件所属的应用信息、环境信息、企业项目信息。

技术栈接口 表5 技术栈接口介绍 API 说明 查询运行时栈 此API用来查询技术栈信息。 查询内置镜像 此API用来获取ServiceStage各个技术栈构建时使用的内置基础镜像。 创建技术栈 此API用来创建自定义技术栈。 根据技术栈ID查询技术栈 此API用来根据技术栈ID查询技术栈。 根据技术栈ID修改技术栈 此API用来根据技术栈ID修改技术栈。 根据技术栈ID删除技术栈 此API用来根据技术栈ID删除技术栈。 发布和取消发布技术栈 此API用来发布和取消发布技术栈。

配置管理接口 表6 配置管理接口介绍 API 说明 创建配置分组 此API用来创建配置分组，用于对配置文件分类管理。 获取配置分组 此API用来获取所有已经创建的配置分组。 创建配置文件 此API用来创建配置文件。 导入配置文件 此API通过导入zip压缩包创建配置文件。 获取配置文件信息 此API用来获取配置文件信息。 根据配置文件ID获取配置文件信息 此API通过配置文件ID获取配置文件的详情。 根据配置文件ID删除配置文件 此API通过配置文件ID删除配置文件。 根据配置文件ID修改配置文件 此API通过配置文件ID修改配置文件。 根据配置文件ID获取配置文件历史 此API通过配置文件ID获取配置文件历史。 根据配置文件历史ID获取配置文件历史信息 此API通过配置文件历史ID获取配置文件历史信息。 根据配置文件历史ID删除配置文件历史 此API通过配置文件历史ID删除配置文件历史。 根据配置分组ID获取分组详情 此API通过配置分组ID获取配置分组详情。 根据配置分组ID删除分组 此API根据配置分组ID删除分组。

应用接口 表3 应用接口 API 说明 创建应用 此API用来创建应用。 获取所有应用 此API用来获取所有应用。 根据应用ID修改应用信息 此API用来通过应用ID修改应用信息。 根据应用ID删除应用 此API用来通过应用ID删除应用。 根据应用ID获取应用详细信息 此API用来通过应用ID获取应用详细信息。 根据应用ID获取应用配置 此API用来通过应用ID获取应用配置信息。 根据应用ID修改应用配置 此API用来通过应用ID修改应用配置。 根据应用ID删除应用配置 此API用来通过应用ID删除应用配置。

响应示例 {"id": "11eddb33-140b-4e51-b1e2-6ec265373ca3","name": "test-micro-test-env-7iafjk","environment_id": "61b81021-21d5-42f3-b80e-0b6bd10dbf7d","platform_type": "cce","flavor_id": "CUSTOM-10G:250m-250m:0.5Gi-0.5Gi","artifacts": {"test-micro": {"storage": "swr","type": "image","url": "swr.region_id.development.com/ns/examples:v2","auth": "iam","version": "1.0.0","properties": {}}},"version": "1.0.2","description": "","configuration": {"env": [{"name": "PAAS_PROJECT_ID","value": "e7d2e9c589e5445e808a8ff0d1235aca","internal": true}],"lifecycle": {"post-start": null,"pre-stop": null},"scheduler": {"affinity": {"az": [],"node": [],"application": []},"anti-affinity": {"az": [],"node": [],"application": []},"isSynchronized": true},"strategy": {"upgrade": "RollingUpdate","spec": {"maxSurge": 0,"maxUnavailable": 1}}},"creator": null,"create_time": 1610331819996,"update_time": 1610522676792,"external_accesses": null,"refer_resources": [{"id": "523498f1-36c4-11eb-ae36-0255ac1000c2","type": "cce","parameters": {"namespace": "default"}},{"id": "default","type": "cse"}],"status_detail": {"status": "RUNNING","replica": 1,"available_replica": 1,"fail_detail": null,"last_job_id": "JOB16c33466-41e6-4c5b-a9ac-2059253a1e5c","last_job_status": "SUCCEEDED","enterprise_project_id": "0"}}

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

URI GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。 instance_id 是 String 组件实例ID。获取方法，请参考获取组件实例。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表3 响应参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 应用创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 应用创建时间。 update_time Integer 应用修改时间。 component_count Integer 应用下部署的组件个数。 labels Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表4。 表4 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。

响应示例 { "id": "e6129197-f9ca-4d60-b84d-a5e71cd2d317", "name": "app-test-0317_03", "description": "", "project_id": "063a3158b1a34710b36ad208b9497d00", "creator": "ss-test", "create_time": 1679036601735, "update_time": 1679036601735, "labels": null, "component_count": 0}

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 应用总数。 applications Array of object 应用信息，请参考表5。 表5 applications 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 应用创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 应用创建时间。 update_time Integer 应用修改时间。 component_count Integer 应用下部署的组件个数。 labels Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表6。 表6 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 { "count": 1, "applications": [ { "id": "dae29983-c1e9-437d-a6be-5256076fe605", "name": "app-xpmtii", "description": "test", "project_id": "063a3158b1a34710b36ad208b9497d00", "enterprise_project_id": "0", "creator": "ss-test", "create_time": 1679468852302, "update_time": 1679468852302, "labels": [ { "key": "key", "value": "var" } ], "component_count": 0 } ]}

URI GET /v3/{project_id}/cas/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参考获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 integer 查询个数，取值[0, 100]。 offset 否 intege 查询偏移量，表示查询第n条数据后的结果。 order_by 否 String 排序字段。 排序字段支持以下枚举值： create_time，应用创建时间，默认排序字段。 name，应用名称。 update_time，应用修改时间。 传值不在支持的枚举值范围内的话按默认排序字段排序。 order 否 String 排序方式。 desc，降序排序，默认排序方式。 asc，升序排序。

URI GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id}/snapshots 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。 instance_id 是 String 组件实例ID。获取方法，请参考获取组件实例。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 Integer 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 { "configuration": [ { "application_id": "fdd7889d-eef8-4db1-befc-7037b02d949e", "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", "configuration": { "env": [ { "name": "app-env", "value": "env" } ] } } ]}

响应消息 表4 响应参数 参数 参数类型 描述 configuration Array of objects 配置列表，请参考表5。 表5 configuration 参数 参数类型 描述 application_id String 应用ID。 environment_id String 环境ID。 configuration Object 环境变量配置，请参考表6。 表6 configurationEnv 参数 参数类型 描述 env Array of object 环境变量，请参考表7。 表7 env 参数 参数类型 描述 name String 变量名。 value String 变量值。

URI GET /v3/{project_id}/cas/applications/{application_id}/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 environment_id 否 String 环境ID。获取方法，请参考获取所有环境。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

URI DELETE /v3/{project_id}/cas/applications/{application_id}/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。

URI DELETE /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。 instance_id 是 String 组件实例ID。获取方法，请参考获取组件实例。 表2 查询参数 参数 是否必选 参数类型 描述 force 否 boolean 是否强制删除。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。