华为云用户手册

请求示例 修改应用对应环境id为0fa75dfe-0d32-4bc1-848b-8008cf3f2567的环境变量配置为名为app-env、值为env的环境变量。 { "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", "configuration": { "env": [ { "name": "app-env", "value": "env" } ] } }

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

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。 configuration 是 Object 环境变量配置，请参考表4。 表4 configuration 参数 是否必选 参数类型 描述 env 是 Array of objects 环境变量，请参考表5。 表5 env 参数 是否必选 参数类型 描述 name 是 String 变量名，应用环境变量的名称，在同一个应用环境下必须唯一。 长度1到64个字符，可以包含英文字母、数字、下划线（_）、中划线（-）或点（.），以英文字母、下划线（_）或中划线（-）开头。 value 是 String 变量值，应用环境变量的值。

响应示例 { "addons": [ { "status": "FAILED", "id": "a2cdf0e2-8495-4db5-82f7-a23b97b57787", "name": "sermantInjector", "version": "1.3.1.0", "cce_id": "02f9a523-cefe-11ee-afc1-0255ac100045", "cse_id": "b4e49ad5-5142-437d-8a6b-1de66b1af0db", "job_id": "JOB195d62a9-6446-4ac4-a42e-034a48d6a10b", "environment_id": "7e2af5b5-4223-40b7-b89b-ee9059827248" } ] }

响应消息 表3 响应参数 参数 参数类型 描述 addons Arrays of objects 插件列表，请参考表4。 表4 addons 参数 参数类型 描述 cce_id String 插件所绑定的CCE集群ID。 cse_id String 插件所绑定的 CS E微服务引擎ID。 environment_id String 插件所在的环境ID。 id String 插件ID job_id String 插件执行的最后一个任务的ID。 name String 插件名称。 sermantInjector：Sermant Injector插件。用于自动挂载Sermant Agent，通过Sermant Agent接入未开启安全认证的ServiceComb引擎。无需修改应用代码即可接入引擎并使用应用注册发现、全链路灰度发布、优雅上下线、标签路由等功能，但是不支持使用微服务治理功能。 status String 插件状态。 INITIALIZING，初始化。 UPGRADING，升级中。 FAILED，失败。 SUCCEEDED，成功。 DELETING，删除中。 version String 插件版本。

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

响应示例 { "environments": [ { "id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "name": "development-env", "description": "", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "deploy_mode": "virtualmachine", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610418873730, "labels": null } ], "count": 1 }

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

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 环境总数。 environments Array of objects 环境参数，请参考表5。 表5 environments 参数 参数类型 描述 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 标签值。

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

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

请求示例 修改名为mycomponet的组件，组件来源使用OBS上bucket0001桶里面的weather-1.0.0.jar包。 { "name": "mycomponet", "description": "", "labels": [ { "key": "com-key", "value": "com-value" } ], "version": "2023.0323.15181", "runtime_stack": { "name": "OpenJDK8", "version": "1.1.1", "type": "Java", "deploy_mode": "virtualmachine" }, "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "version": "", "storage": "obs" }, "tomcat_opts": { "server_xml": "" }, "refer_resources": [ { "id": "67835bb3-1235-4cc9-be71-becbb2b4ca0d", "type": "ecs" } ], "replica": 1, "external_accesses": [] }

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

请求消息 表3 请求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}/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，升序排序。

响应示例 { "snapshots": [ { "version": "1.0.0", "description": "{\"action\":\"New Version: 1.0.0\"}", "instance_id": "11eddb33-140b-4e51-b1e2-6ec265373ca3", "create_time": 1610331830841 } ], "count": 1 }

请求示例 修改应用名称为app-xpmtii2，描述信息修改为test2，标签键值对修改为"key":"var"。 { "name": "app-xpmtii2", "description": "test2", "labels": [ { "key": "key", "value": "var" } ] }

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

请求消息 表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个字符。 description 否 String 应用描述。 最大长度为128个字符。 enterprise_project_id 否 String 企业项目ID。 labels 否 Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表4。 同一个应用下最多可以添加20个标签。 表4 labels 参数 是否必选 参数类型 描述 key 是 String 标签名称。 标签用于标识资源，当您拥有相同类型的许多资源时，可以使用标签按各种维度（例如用途、所有者或环境）对资源进行分类。 长度为1到36个字符，只能包含数字、英文字母、下划线（_）、中划线（-）或中文。 value 是 String 标签值。 长度为1到43个字符，只能包含数字、英文字母、下划线（_）、点（.）、中划线（-）或中文。

响应消息 表5 响应参数 参数 参数类型 描述 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 标签值。

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

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 组件任务类型。 start，启动。 stop，停止。 restart，重启。 scale，伸缩。 rollback，回滚。 rollback_current，回滚到上一个版本。 continue_deploy，继续部署。 check_gray_release，检查灰度规则。 modify_gray_rule，修改灰度规则。 sync_workload，同步工作负载。 parameters 否 Object 任务参数，请参考表4。 表4 parameters 参数 是否必选 参数类型 描述 replica 否 Integer 组件实例数量。 version 否 String 版本号。 hosts 否 Array of String hostID列表，当虚机部署组件伸缩时必选。

响应示例 { "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 }

响应消息 表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 标签值。

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

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 配置文件总数。 configs Array of objects 配置文件列表，请参考表5。 表5 configs 参数 参数类型 描述 config_group_id String 配置分组ID。 id String 配置文件ID。 name String 配置文件名称。 description String 配置文件描述。 creator String 创建人。 type String 配置文件类型： yaml properties content String 配置文件内容。 version String 配置文件版本号。 project_id String 项目ID。 sensitive Boolean 配置文件内容是否加密： true，加密。 false，不加密。 components Array of objects 配置文件绑定的组件列表，请参考表6。 create_time Integer 创建时间。 update_time Integer 修改时间。 表6 components 参数 参数类型 描述 application_id String 应用ID。 component_id String 组件ID。 component_name String 组件名称。 environment_id String 环境ID。

响应示例 { "configs": [{ "id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1", "config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b", "name": "test-config1", "description": null, "type": "properties", "content": "testKey = testValue", "version": "v1", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "sensitive": false, "create_time": 1717486892611, "update_time": 1717486892611, "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": "2cb1897e-c23b-48a5-993c-dc7ad3c552a0", "config_group_id": "f3e6d5b4-4d7d-4009-b806-22cfed2ac6ea", "name": "test-config2", "description": null, "type": "properties", "content": "testKey = testValue", "version": "v1", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "sensitive": false, "create_time": 1717486590467, "update_time": 1717486590467, "components": [], "creator": "ss-test" }], "count": 2 }

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

URI GET /v3/{project_id}/cas/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 name 否 String 配置文件名称。 config_group_id 否 String 配置分组ID。 component_id 否 String 组件ID。 limit 否 integer 指定个数，取值[0, 100]。 offset 否 integer 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 create_time，配置文件创建时间。 name，配置文件名称。 update_time，配置文件修改时间。 order 否 String 排序方式。 desc，降序排序，默认排序方式。 asc，升序排序。

响应示例 { "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" : "test_user", "create_time" : 1722848532908, "update_time" : 1722848532908, "instances" : [{ "id" : "8d2665d9-2420-42a4-8c30-8f4f10b75edd", "name" : "comp-qor4hy12", "version" : "1.0.1", "application_id" : "520dc8fd-a333-402f-bef7-4412ced5a452", "application_name" : "app-apitest-cgWi", "status" : "RUNNING", "runtime_stack" : { "type" : "Tomcat", "name" : "Tomcat8/OpenJDK8", "version" : null, }, "replica" : 1 } ], "instance_count" : 2, "weight" : 100, "latest_opt" : null, "release_plan_id" : null }