华为云用户手册

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of objects 添加资源，请参考表4。 表4 resources 参数 是否必选 参数类型 描述 id 是 String 资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。 name 否 String 资源名称。 type 是 String 资源类型。 eip，弹性公网IP。 elb，弹性负载均衡。 cce，云容器引擎。 ecs，弹性云服务器。 as，弹性伸缩组。 cse，ServiceComb引擎。 nacos，注册配置中心。 ms_gateway，应用网关。 仅“华东-上海一”、“亚太-新加坡”区域支持纳管应用网关，用于使用全链路流量控制功能。 dcs，分布式缓存服务。 rds，云数据库。 subnet，子网。 acl，网络ACL。

URI DELETE /v3/{project_id}/cas/configs/{config_id}/histories/{config_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 config_id 是 String 配置文件ID。获取方法，请参考获取配置文件信息。 config_history_id 是 String 配置文件历史ID。获取方法，请参考根据配置文件ID获取配置文件历史。

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

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

请求示例 创建名称为component-instance-name的组件实例，组件实例运行环境选择ID为6e763000-9128-4a9d-adea-34c42cc5344d的环境，组件部署件选择存储在obs下myapp桶中的demo.jar包，部署资源选择id为b6862a62-d916-11e9-bdf1-0255ac101fd9的CCE和id为8c0a45cc-626f-4d65-8257-507ee059aa9a的ELB。 { "name": "component-instance-name", "environment_id": "6e763000-9128-4a9d-adea-34c42cc5344d", "flavor_id": "MICRO-5G:0.5m:1G", "replica": 1, "artifacts": { "container-name": { "storage": "obs", "type": "package", "url": "obs://myapp/demo.jar", "properties": { "bucket": "myapp", "key": "demo.jar", "endpoint": "https://obs.region_id.external_domain_name.com" }, "auth": "iam" } }, "version": 1, "description": "instance desc", "configuration": { "env": [ { "name": "log-level", "value": "warn" } ] }, "refer_resources": [ { "id": "b6862a62-d916-11e9-bdf1-0255ac101fd9", "type": "cce", "parameters": { "namespace": "default" } }, { "id": "8c0a45cc-626f-4d65-8257-507ee059aa9a", "type": "elb" } ] }

请求示例 创建虚拟机部署类型的自定义Java技术栈版本。 { "name": "test", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.0.0", "description": "1234", "spec": { "parameters": { "jdk_url": "obs://cyf/bisheng-jdk-8u412-linux-aarch64.tar.gz" } } }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 技术栈名称。 deploy_mode 是 String 部署类型。 目前仅支持virtualmachine（虚拟机部署）类型。 type 是 String 技术栈类型。 目前仅支持Java、Tomcat。 version 是 String 版本号。 spec 否 Object 技术栈相关参数，请参考表4。 description 否 String 技术栈描述。

响应示例 { "id": "cf4727f0-0d6f-43d5-b1b8-f2c1f09d1611", "name": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.0.0", "description": "1234", "spec": { "os": null, "sdk": null, "parameters": { "jdk_url": "obs://cyf/bisheng-jdk-8u412-linux-aarch64.tar.gz" } }, "system": 0, "status": "Disable", "creator": "cyf", "create_time": 1722934506431, "update_time": 1722934506431 }

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

响应示例 { "id": "cf4727f0-0d6f-43d5-b1b8-f2c1f09d1611", "name": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.0.0", "description": "1234", "spec": { "os": null, "sdk": null, "parameters": { "jdk_url": "obs://cyf/bisheng-jdk-8u412-linux-aarch64.tar.gz" } }, "system": 0, "status": "Disable", "creator": "cyf", "create_time": 1722934506431, "update_time": 1722934506431 }

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

URI GET /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。 addon_id 是 String 插件ID。获取方法，请参考查询插件列表。

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

响应示例 { "status": "SUCCEEDED", "id": "d52025c9-8e8f-44c0-994e-9f42f87eebd2", "name": "sermantInjector", "version": "1.3.1.0", "cce_id": "7bc15618-f875-11ee-9505-0255ac100b08", "cse_id": "98d033a9-d631-47d7-a63f-0cd8039f7028", "job_id": "JOB8d13e3a3-a0cc-404a-955d-efe148e6ab6f", "environment_id": "48874c71-4898-442f-87fc-afff135d65d1" }

请求示例 修改环境名称为development-env，描述设置为空，为环境增加键值对为"test": "value"的标签。 { "name": "development-env", "description": "", "labels": [ { "key": "test", "value": "value" } ] }

响应示例 { "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, "resources": [ { "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80", "type": "ecs", "name": "ecs-test" } ], "labels": [ { "key": "test", "value": "value" } ] }

响应消息 表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。 resources Array of objects 资源，请参考表7。 表6 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。 表7 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 资源类型。 vpc，虚拟私有云。 eip，弹性公网IP。 elb，弹性负载均衡。 cce，云容器引擎。 ecs，弹性云服务器。 as，弹性伸缩组。 cse，ServiceComb引擎。 nacos，注册配置中心。 ms_gateway，应用网关。 仅“华东-上海一”、“亚太-新加坡”区域支持纳管应用网关，用于使用全链路流量控制功能。 dcs，分布式缓存服务。 rds，云数据库。 subnet，子网。 acl，网络ACL。

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

响应示例 { "runtime_stacks": [{ "id": "1c5e7000-f2f2-4fc2-988f-0a22ca67940f", "name": "OpenJDK11", "project_id": "578ac30b81034b89a7255b3af26db9c9", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.3.7", "spec": { "os": "Linux", "sdk": "OpenJDK-11.0.23", "parameters": null }, "system": 1, "status": "Supported", "create_time": 1722416061588, "update_time": 1722416098865, "component_count": 3 }, { "id": "b153f6b8-9335-46a1-913e-c2d8f966d4b2", "name": "CustomJdk", "project_id": "578ac30b81034b89a7255b3af26db9c9", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.0.0", "spec": { "os": null, "sdk": null, "parameters": { "jdk_url": "obs://cyf/bisheng-jdk-8u412-linux-aarch64.tar.gz" } }, "system": 0, "status": "Disable", "creator": "cyf", "create_time": 1722932102641, "update_time": 1722932102641, "component_count": 0 }], "total": 2 }

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

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

URI POST /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。 addon_id 是 String 插件ID。获取方法，请参考查询插件列表。

响应示例 { "count": 1, "applications": [ { "id": "e5213b62-0e3c-476f-9960-3e4108787350", "name": "app-xpmtii", "description": "test", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "creator": "ss-test", "create_time": 1610432385245, "update_time": 1610432385245, "unified_model": null, "component_count": 0 } ] }

URI GET /v2/{project_id}/cas/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参考获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 String 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 String 指定偏移量，表示查询第n条数据后的结果。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值：create_time，name，update_time。传的值不在支持的枚举值范围内的话按默认排序字段排序。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 应用总数。 applications Array of objects 应用信息，请参考表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 修改时间。 unified_model String 是否开启统一模型，返回固定值null。 component_count Integer 组件个数。

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

请求示例 场景一：CCE容器环境下创建组件 创建名为mycomponent的组件。组件部署使用1.2.0版本的Java技术栈，组件来源选择存储在OBS下bucket00001桶里的weather-1.0.0.jar包，部署使用的资源为id为fd92bfab-73b3-11ee-90f0-0255ac1001b3的云容器引擎。 { "name": "mycomponent", "description": "", "labels": [ { "key": "com-key", "value": "com-value" } ], "version": "2023.1102.17105", "environment_id": "b489f7b4-2539-45a1-ba71-4728961434ca", "runtime_stack": { "name": "OpenJDK8", "version": "1.2.0", "type": "Java", "deploy_mode": "container" }, "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "version": "", "storage": "obs" }, "tomcat_opts": { "server_xml": "" }, "refer_resources": [ { "id": "fd92bfab-73b3-11ee-90f0-0255ac1001b3", "type": "cce", } ], "replica": 1, "limit_cpu": 0.25, "limit_memory": 0.5, "request_cpu": 0.25, "request_memory": 0.5 } 场景二：ECS虚拟机环境下创建组件 创建名为mycomponent的组件。组件部署使用1.2.0版本的Java技术栈，组件来源选择存储在OBS下bucket00001桶里的weather-1.0.0.jar包，部署使用的资源为id为67835bb3-1235-4cc9-be71-becbb2b4ca0d的弹性云服务器。 { "name": "mycomponent", "description": "", "labels": [ { "key": "com-key", "value": "com-value" } ], "version": "2023.1102.17540", "environment_id": "9a075df5-104f-4e21-9dbf-ffc3572effdf", "runtime_stack": { "name": "OpenJDK8", "version": "1.2.0", "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": "23598aa9-7a6b-43c7-a53a-39ca5e7290fb", "type": "ecs" } ], "replica": 1, "external_accesses": [ { "protocol": "http", "address": "192.168.0.169", "forward_port": 80 } ] }

响应示例 { "id": "cf4727f0-0d6f-43d5-b1b8-f2c1f09d1611", "name": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.0.0", "description": "12345", "spec": { "os": null, "sdk": null, "parameters": { "jdk_url": "obs://cyf/bisheng-jdk-8u412-linux-aarch64.tar.gz" } }, "system": 0, "status": "Disable", "creator": "cyf", "create_time": 1722934506431, "update_time": 1722934506431 }

请求示例 编辑虚拟机部署类型的自定义Java技术栈版本的名称和描述信息。 { "name": "CustomJdk", "deploy_mode": "virtualmachine", "type": "Java", "version": "1.0.0", "description": "12345", "spec": { "parameters": { "jdk_url": "obs://cyf/bisheng-jdk-8u412-linux-aarch64.tar.gz" } } }

响应消息 表3 响应参数 参数 参数类型 描述 resources Array of objects 资源，请参考表4。 表4 schemas 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 资源类型。 eip，弹性公网IP。 elb，弹性负载均衡。 cce，云容器引擎。 ecs，弹性云服务器。 dcs，分布式缓存服务。 rds，云数据库。 cse，ServiceComb引擎。 nacos，注册配置中心。 ms_gateway，应用网关。 subnet，子网。 acl，网络ACL。