华为云用户手册

响应消息 表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 变量值。

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

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。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 id String 微服务引擎专享版ID。 name String 微服务引擎专享版名称。 jobId Integer 微服务引擎专享版执行任务ID。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

请求示例 创建一个名称为“test”微服务引擎专享版，其计费模式为按需计费，规格为cse.s1.small2，可用区为test，关闭安全认证，微服务引擎的部署类型为 CS E2。 POST https://{endpoint}/v2/{project_id}/enginemgr/engines { "name": "test", "description": "test", "payment": "1", "flavor": "cse.s1.small2", "azList": ["test"], "authType": "NONE", "vpc": "vpc-demotest", "vpcId": "09902850-9454-4715-9764-018f0c37022", "networkId": "88550801-e892-4f8e-b21b-f7147f6229", "subnetCidr": "192.168.0.5/26", "specType": "CSE2, "inputs": { "nodeFlavor": "s6.large.2" } }

响应示例 { "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb" } ], "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ], "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "name": "test", "gray_release_type": "WEIGHT", "description": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "creator": "test_user", "create_time": 1726623793113, "update_time": 1726623793113, "swimlanes": [ { "id": "1cd0cb71-5d5d-41a0-8b05-f7ed53400cf7", "name": "base", "swimlane_group_id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "type": "BASE", "tag": "base", "route_status": "ENABLE", "rule_match_mode": null, "project_id": "578ac30b81034b89a7255b3af26db9c9", "rules": null, "creator": "test_user", "create_time": 1726626094346, "update_time": 1726626094346, "instances": [ { "id": "5fd78836-301e-4750-bdc9-be8a9e43b19a", "name": "weater-beta", "version": "2024.0914.17114", "application_id": "69993ce9-e468-3349-acb8-a30b85b17de5", "application_name": "weathermap", "status": "RUNNING", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "runtime_stack": { "url": "openjdk-{arch}:8-1.3.8", "type": "Java", "name": "OpenJDK8", "deploy_mode": "container", "version": "1.3.8", "status": "Supported", }, "replica": 1 } ], "instance_count": 1, "weight": 100, "latest_opt": null, "release_plan_id": null } ], "swimlane_count": 1, "engine_ids": [ "d68a5ca7-b5b6-4917-a464-0adef94b8067" ] }

响应消息 表3 响应参数 参数 参数类型 描述 description String 泳道组的描述。 gateways Array of objects 流量网关入口，请参考表4。 gray_release_type String 灰度发布类型。 WEIGHT：基于流量比例进行全链路灰度。 CONTENT：基于内容进行全链路灰度。 id String 泳道组的ID。 name String 泳道组的名称。 swimlane_count Integer 泳道组下的泳道数量。 swimlanes Array of objects 泳道组下的泳道列表，请参考表6。 creator String 创建者。 create_time String 创建时间。 update_time String 更新时间 project_id String 租户项目ID。获取方法，请参考获取项目ID。 target_services Array of objects 目标服务列表。请参考表5。 engine_ids Array of string 引擎ID列表。 表4 gateways 参数 参数类型 描述 engine_id String 网关引擎ID。 id String 网关ID。 name String 网关名称。 target_services Array of objects 目标服务列表。请参考表5。 表5 target_services 参数 是否必选 参数类型 描述 host 是 String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成，以点号（.）分隔。 例如，unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称，testing为unit-controller微服务所在环境名，test-application为unit-controller微服务所属应用名称，servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name 否 String 目标服务名称。 id 是 String 目标服务ID。 engine_id 是 String 引擎ID。 engine_type 是 String 引擎类型。 servicecomb：ServiceComb引擎。 nacos：注册配置中心。 表6 swimlanes 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE：基线泳道。 GRAY：灰度泳道。 tag String 泳道标签，用于根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE：开启路由。 DISABLED：关闭路由。 rule_match_mode String 路由规则匹配模式，当泳道组灰度类型为基于内容即gray_release_type为CONTENT时生效。 ALL：匹配所有的规则。 ANY：匹配任一规则。 rules Array of objects 路由规则，当泳道组灰度类型为基于内容即gray_release_type为CONTENT时生效。请参考表7。 weight Integer 泳道流量权重，范围在0-100之间。 当泳道组灰度类型为基于流量即gray_release_type为WEIGHT时生效。 instances Array of objects 泳道中纳管的组件列表，请参考表8。 instance_count Integer 泳道中纳管的组件个数。 latest_opt String 泳道上一步的操作。 CLONE：克隆。 UPGRADE：升级。 ROLLBACK：回滚。 CREATE：创建。 release_plan_id String 泳道上一步操作关联的发布单ID。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表7 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER，即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT：精确匹配。 PREFIX：前缀匹配。 REGEX：正则匹配。 表8 instances 参数 参数类型 描述 id String 应用组件实例ID。 name String 应用组件实例名称。 version String 应用组件版本号。 application_id String 应用ID。 component_id String 组件ID。 application_name String 应用名称。 status String 实例状态 engine_id String 组件关联引擎ID。 runtime_stack Object 运行时，请参考表9。 replica Integer 实例副本数。 表9 runtime_stack 参数 参数类型 描述 name String 技术栈名称。 type String 技术栈类型，支持Java、Tomcat、Nodejs、Php、Docker、Python。 当部署模式为虚机部署时，仅支持Java、Tomcat、Nodejs；容器部署上述类型都支持。 version String 技术栈版本。 deploy_mode String 部署模式。 container，容器部署。 virtualmachine，虚机部署。 url String 技术栈路径。 status String 技术栈状态。

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

请求示例 将ID为30f88521-fa43-42ff-aaec-9cac4259fb16的组件实例从泳道中删除。 { "parameters": { "components": [ { "id": "30f88521-fa43-42ff-aaec-9cac4259fb16", "application_id": "f397be2a-4c49-4ed8-8144-ce13417e179d" } ] }, "action": "delete" }

URI POST /v3/{project_id}/cas/swimlane-group/{lane_group_id}/swimlane/{lane_id}/components-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 lane_group_id 是 String 泳道组ID。获取方法，请参考获取所有泳道组。 lane_id 是 String 泳道ID。获取方法，请参考获取泳道组下所有泳道。

响应消息 表5 响应参数 参数 参数类型 描述 id String 环境ID。 name String 环境名称。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 deploy_mode String 环境类型。 vpc_id String 虚拟私有云ID。 creator String 环境创建人。 create_time Integer 环境创建时间。 update_time Integer 环境修改时间。 labels Array of objects 标签，可使用标签管理服务通过标签过滤查询资源信息，请参考表6。 表6 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。

响应示例 { "id": "c93a5313-d141-4b9f-97ce-b4ce2b3988bd", "name": "test", "description": "", "project_id": "13ae26238d724e54947af3e0fcbef9c3", "enterprise_project_id": "0", "vpc_id": "0c72428b-cd6c-4283-a560-210d3edb49f7", "creator": "ss-test", "create_time": 1681384236023, "update_time": 1681384236023, "deploy_mode": "virtualmachine", "labels": [] }

请求示例 创建名称为env-test的“虚拟机”类型环境，环境所在VPC的id为0c72428b-cd6c-4283-a560-210d3edb49f7。 { "name": "env-test", "description": "", "enterprise_project_id": "0", "vpc_id": "0c72428b-cd6c-4283-a560-210d3edb49f7", "labels": [ { "key": "aaaaa", "value": "a5" } ], "deploy_mode": "virtualmachine" }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 环境名称。 由英文字母、数字、中划线（-）或下划线（_）组成，并以英文字母开头，英文字母或者数字结尾，英文字母区分大小写，长度为2~64个字符。 deploy_mode 否 String 环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 description 否 String 环境描述。 最大长度为128个字符。 enterprise_project_id 否 String 企业项目ID。 vpc_id 是 String 虚拟私有云ID。 labels 否 Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表4。 同一个环境下最多可以添加20个标签。 表4 labels 参数 是否必选 参数类型 描述 key 是 String 标签名称。 标签用于标识资源，当您拥有相同类型的许多资源时，可以使用标签按各种维度（例如用途、所有者或环境）对资源进行分类。 长度为1到36个字符，只能包含数字、英文字母、下划线（_）、中划线（-）或中文。 value 是 String 标签值。 长度为1到43个字符，只能包含数字、英文字母、下划线（_）、点（.）、中划线（-）或中文。

功能介绍 环境是用于组件部署和运行的计算（如云容器引擎 CCE、弹性云服务器 ECS等）、网络（如弹性负载均衡 ELB、弹性IP EIP等）和中间件（如分布式缓存 DCS、云数据库 RDS等）等基础资源的集合。ServiceStage把多种基础资源组合为一个环境，如：开发环境、测试环境、预生产环境和生产环境。按环境维度来管理资源、部署组件，可以减少具体基础资源运维管理的复杂性。 此API用于创建环境。

响应示例 { "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。获取方法，请参考获取组件实例。

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

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 是否强制删除。

URI GET /v3/{project_id}/cas/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。 表2 查询参数 参数 是否必选 参数类型 描述 version 否 String 组件版本号。获取方法，请参考获取应用所有组件。

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

响应示例 { "name": "test-component", "description": "", "labels": [], "runtime_stack": { "type": "Java", "name": "OpenJDK8", "deploy_mode": "virtualmachine", "version": "1.1.1" }, "id": "b8702b0f-94d3-4822-98a1-56815632a0a0", "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "storage": "obs" }, "environment_id": "4d084044-0b80-4641-963c-b9c9f4092a4f", "application_id": "fc092465-a5fb-4a52-bc65-b735f18366d8", "replica": 1, "version": "2023.0323.15181", "envs": [], "tomcat_opts": { "server_xml": "", "http_port": 0, "context_path": null }, "refer_resources": [ { "id": "Default", "type": "ecs", "parameters": { "hosts": [ "67835bb3-1235-4cc9-be71-becbb2b4ca0d" ] } } ], "status": { "component_status": "RUNNING", "available_replica": 1, "replica": 1, "fail_detail": null, "last_job_id": "JOB1c8e20ec-1b30-4ee4-9a36-35a18b5e8b7e", "creator": null, "create_time": 1679556221933, "update_time": 1679579448500, }, "workload_kind": "deployment" }

URI POST /v3/{project_id}/cas/swimlane-group/{lane_group_id}/swimlane/{lane_id}/components-action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 lane_group_id 是 String 泳道组ID。获取方法，请参考获取所有泳道组。 lane_id 是 String 泳道ID。获取方法，请参考获取泳道组下所有泳道。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 泳道组件实例纳管移除操作。 ADD：纳管组件。 REMOVE：移除组件。 instance_ids 是 Array of String 组件实例列表。

响应示例 { "id": "8f8a5b33-ee1f-4a70-b3a9-c1b179a69fd2", "name": "base", "swimlane_group_id": "5447f910-ab74-4d15-b2ab-dd0945900ce9", "type": "BASE", "tag": "base", "route_status": "ENABLE", "rule_match_mode": null, "project_id": "86a1f7b663b349e89071a3090d9d81f3", "rules": null, "creator": "w00842292", "create_time": 1722848532908, "update_time": 1722848532908, "instances": [ { "componentId": "0b582884-1ad0-4183-8d6d-16998f54818f", "id": "887f99d7-4ce5-431d-924f-6a328cb05572", "name": "comp-uh59l7s2", "version": "1.0.0", "application_id": "70502782-4f93-4eda-af19-415bac2d12ae", "application_name": "app-apitest-1o6l", "replica": 0 } ], "instance_count": 1, "weight": 100, "batch_status": null, "latest_opt": null, "release_plan_id": null }

响应示例 { "id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1", "config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b", "name": "test-config1", "description": "", "type": "properties", "content": "testKey = testModify", "version": "v2", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "sensitive": false, "create_time": 1717486892611, "update_time": 1717491574202, "components": [{ "application_id": "8a3be48a-6401-4e8c-bbce-033745252227", "component_id": "4b611997-4acd-4538-a06b-32fd2475e057", "component_name": "component-test1", "environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51" }], "creator": "ss-test" }

请求示例 修改配置文件的分组ID为4808b50d-d7f3-401b-9175-968cb4f9892b、配置文件类型为properties、文件内容为testKey = testModify、不加密文件内容。 { "config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b", "description": "", "type": "properties", "content": "testKey = testModify", "sensitive": false }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 config_group_id 是 String 配置分组ID。 content 是 String 配置文件内容。 type 是 String 配置文件格式。 description 否 String 配置文件描述。 sensitive 否 Boolean 配置文件内容是否加密： true，加密。 false，不加密。