华为云用户手册

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

响应示例 { "components": [ { "id": "384eb8d4-c193-4d84-9558-6fda2366b536", "name": "mycomponent", "runtime": "Java8", "category": "MicroService", "sub_category": "Java Chassis", "description": "", "project_id": "384eb8d4-c193-4d84-9558-6fda23698536", "application_id": "a8f7eed5-0aa0-4251-9723-c9119a6bf56d", "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://myapp/demo.jar", "properties": { "bucket": "myapp", "key": "demo.jar", "endpoint": "https://obs.region_id.external_domain_name.com" } } }, "build": { "id": "w3dpv7p0t1vpxvey5hjb22iuwxway1vupwx0nae1", "parameters": { "artifact_namespace": "ns", "use_public_cluster": true } }, "status": 0, "creator": "test_user", "create_time": 1610333934288, "update_time": 1610333934288 } ], "count": 1 }

请求消息 表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 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 String 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 String 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值：create_time、name、update_time。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

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

响应示例 { "flavors": [ { "flavor_id": "MICRO-5G:0.5C:1G", "storage_size": "5G", "num_cpu": "500m", "num_cpu_init": "200m", "memory_size": "1Gi", "memory_size_init": "200Mi", "label": "Micro: 5G Storage, 0.5 CPU, 1G Memory", "custom": false } ] }

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

响应消息 表3 响应参数 参数 参数类型 描述 flavors Array of objects 规格参数，请参考表4。 表4 flavors 参数 参数类型 描述 flavor_id String 规格ID storage_size String 存储大小 num_cpu String CPU限制 num_cpu_init String CPU初始 memory_size String 内存限制 memory_size_init String 内存初始 label String 展示标签 custom boolean 是否是自定义资源规格

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 配置分组名称。 由大小写英文字母、数字、中划线（-）、下划线（_）组成，并以大小写英文字母开头，大小写英文字母或者数字结尾，长度为2~64个字符。 description 否 String 配置分组描述。 最大长度为256个字符。

响应示例 { "id": "0f5722ea-ee97-42bf-8583-404caa0a46e5", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "name": "test-group", "description": "", "create_time": 1717482692680, "creator": "ss-test" }

请求消息 表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 环境名称。 alias String 环境别名。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 charge_mode String 收费模式。 deploy_mode String 环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 vpc_id String 虚拟私有云ID。 base_resources Array of objects 基础资源，请参考表4。 optional_resources Array of objects 可选资源，请参考表4。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表4 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。

响应示例 { "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", "name": "dev-env", "alias": null, "description": "develop environment", "project_id": "bf8523d898b64e4eb956e3be3555ca16", "enterprise_project_id": "0", "charge_mode": "provided", "deploy_mode": "container", "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", "base_resources": [ { "id": "211112333sd332w23322332", "type": "cce" } ], "optional_resources": null, "creator": "string", "create_time": 1578984198394, "update_time": 1578984198394 }

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

响应示例 { "id": "1cfdda6f-84cd-4ead-8e09-628fabf662e2", "name": "test-micro", "runtime": "Java8", "category": "MicroService", "sub_category": "Java Chassis", "description": "", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "application_id": "4d92833a-fa05-4fc0-a761-e67620022310", "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://test-soft/fusionweather-1.0.0.jar", "auth": "iam", "webUrl": "", "properties": { "bucket": "test-soft", "endpoint": "https://obs.region_id.development.com:443", "key": "fusionweather-1.0.0.jar" } } }, "build": { "id": "zpdkj42b3rnko8bmyojzt1ng828ubychw13j8flv", "parameters": { "artifact_namespace": "ns", "use_public_cluster": false, "cluster_id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "cluster_name": "cce-test", "cluster_type": "VirtualMachine" } }, "status": 0, "creator": "ss-test", "create_time": 1610331760105, "update_time": 1610519881943 }

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

响应示例 { "instances": [ { "id": "11eddb33-140b-4e51-b1e2-6ec265373ca3", "application_id": "4d92833a-fa05-4fc0-a761-e67620022310", "application_name": "test-app", "component_id": "1cfdda6f-84cd-4ead-8e09-628fabf662e2", "component_name": "test-com", "name": "test-micro-test-env-7iafjk", "environment_id": "61b81021-21d5-42f3-b80e-0b6bd10dbf7d", "environment_name": "test-env", "platform_type": "cce", "version": "1.0.0", "artifacts": { "test-micro": { "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.0.0", } }, "create_time": 1610331819996, "update_time": 1610331830398, "creator": "test_user", "status_detail": { "status": "RUNNING", "replica": 1, "available_replica": 1, "fail_detail": null, "last_job_id": "JOB7bc0366c-dc43-41f9-b65f-8d6078038488", "last_job_status": "SUCCEEDED", "enterprise_project_id": "0" } } ], "count": 1 }

URI GET /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。获取方法，请参考获取应用所有组件。 表2 查询参数 参数 是否必选 参数类型 描述 maxWaitTime 否 int 用户自定义整体启动时间。 limit 否 Integer 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 Integer 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值：create_time、name、version、update_time。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

响应示例 { "components": [ { "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "storage": "obs" }, "name": "mycomponent", "id": "b8702b0f-94d3-4822-98a1-56815632a0a0", "labels": null, "runtime_stack": { "name": "OpenJDK8", "deploy_mode": "virtualmachine", "version": "1.1.1" }, "external_accesses": null, "status": { "component_status": "RUNNING", "available_replica": 1, "replica": 1, "fail_detail": null, "last_job_id": "JOB8be53b2a-af9a-4e2b-8505-096688a52237", "creator": "ss-test", "create_time": 1679556221028, "update_time": 1679556318779 }, "environment_name": "sudo", "environment_id": "4d084044-0b80-4641-963c-b9c9f4092a4f", "application_name": "app-39mbbn", "application_id": "fc092465-a5fb-4a52-bc65-b735f18366d8", "creator": "ss-test", "platform_type": "cce", "version": "2023.0323.15181" } ], "count": 1 }

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 组件总数。 components Array of objects 组件参数，请参考表5。 表5 components 参数 参数类型 描述 id String 组件ID。 name String 组件名称。 labels Array of objects 标签。容器部署可通过标签查询对应工作负载，虚机部署可配置对应的微服务名称的标签来使用优雅上下线功能，请参考表10。 status Object 组件状态，请参考表8。 runtime_stack Object 技术栈，请参考表7。 application_name String 应用名称。 application_id String 应用ID。 environment_name String 环境名称。 environment_id String 环境ID。 version String 版本号。 source Object 代码/软件包来源，请参考表6。 creator String 创建人。 platform_type String 部署类型。 external_accesses Array of Objects 外部访问，请参考表11。 表6 source 参数 参数类型 描述 kind String 组件来源类型。 code，源码。 package，软件包。 image，镜像包。 version String 版本号。 url String 包地址，类型为package和image时需要添加。 storage String 存储方式，例如：obs。 auth String 认证方式，例如：iam。 repo_auth String 授权名称。 repo_namespace String 代码仓库命名空间。 repo_ref String 代码分支或者Tag，例如：master。 repo_type String 代码仓类型，例如：CodeArts、Gitee、GitHub、BitBucket、GitLab。 web_url String 代码跳转链接，例如：https://github.com/example/demo.git。 repo_url String 代码仓url，例如：https://github.com/example/demo.git。 表7 runtime_stack 参数 参数类型 描述 name String 技术栈名称。 type String 技术栈类型，支持Java、Tomcat、Nodejs、Php、Docker、Python。 当部署模式为虚机部署时，仅支持Java、Tomcat、Nodejs；容器部署上述类型都支持。 version String 技术栈版本。 deploy_mode String 部署模式。 表8 status参数 参数 参数类型 描述 component_status String 组件状态。 INITIALIZING，初始化。 UPGRADING，升级中。 FAILED，失败。 RUNNING，运行中。 DOWN，下线。 DELETING，删除中。 DELETED，已删除。 RESERVED，保留。 STARTING，启动中。 STOPPING，停止中。 STOPPED，停止。 RESTARTING，重启中。 PENDING，未就绪。 UNKNOWN，未知。 PARTIALLY_FAILED，部分失败。 available_replica Integer 可用实例。 replica Integer 总实例。 fail_detail String 失败原因。 cluster_deleted，集群被删除。 cluster_unavailable，集群不可用。 cluster_inaccessible，集群无法访问。 namespace_deleted，命名空间被删除。 namespace_unavailable，命名空间不可用。 namespace_inaccessible，命名空间无法访问。 resource_deleted，资源已删除。 create_failed，创建组件失败。 delete_failed，删除组件失败。 last_job_id String 最后执行任务ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 artifact Object 组件构建信息，请参考表9。 表9 artifact 参数 参数类型 描述 type String 组件来源类型。 虚拟机部署支持软件包package。 容器部署支持软件包package、镜像包image。 url String 软件包/镜像地址。 表10 labels 参数 参数类型 描述 key String 标签名称 value String 标签值 表11 external_accesses 参数 参数类型 描述 protocol String 外部访问类型，取值范围为：http、https。 address String 外部访问地址。 forward_port Integer 外部访问端口。

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

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），设置为： multipart/form-data X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 upload_file 是 File 导入的配置文件需要压缩成zip格式，且压缩包文件大小不能超过500KB。 导入的压缩包中的配置文件数不能超过500个。 压缩包中的文件夹名称为配置分组名称，文件名称为配置名称，文件类型支持yaml、properties格式。 repetition_policy 否 String 导入配置文件中同名配置文件处理策略： covered：覆盖，用导入的配置文件替换分组下已有同名配置文件。 skip：跳过，跳过导入同名配置文件。

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

响应消息 表3 响应参数 参数 参数类型 描述 addons Arrays of objects 插件版本信息，请参考表4。 表4 addons 参数 参数类型 描述 name String 插件名称。 sermantInjector：Sermant Injector插件。用于自动挂载Sermant Agent，通过Sermant Agent接入未开启安全认证的ServiceComb引擎。无需修改应用代码即可接入引擎并使用应用注册发现、全链路灰度发布、优雅上下线、标签路由等功能，但是不支持使用微服务治理功能。 latest_version String 插件最新版本。

响应示例 { "id": "9974a8b3-cbd7-4084-bac9-194f7d5ba3da", "name": "gray", "swimlane_group_id": "b76dad96-66cf-4ae7-aa55-11b6d630e777", "type": "GRAY", "tag": "gray", "weight": 0, "route_status": "DISABLED", "rule_match_mode": null, "project_id": "4008a952b3f44b5a919c9a48d90811f3", "rules": null, "creator": "test_user", "create_time": 1722928561358, "update_time": 1722928561358 }

响应消息 表4 响应参数 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE：基线泳道。 GRAY：灰度泳道。 tag String 泳道标签，根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE：开启路由。 DISABLE：关闭路由。 rule_match_mode String 路由规则匹配模式。 当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。 ALL：匹配所有的规则。 ANY：匹配任一规则。 rules Array of objects 路由规则。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。请参考表5。 weight Integer 泳道流量权重，范围在0-100之间。当泳道组灰度类型为基于流量，即gray_release_type为WEIGHT时生效。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表5 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER，即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT：精确匹配。 PREFIX：前缀匹配。 REGEX：正则匹配。

请求消息 表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个字符。 tag 是 String 泳道的标签。 type 是 String 泳道的类型。当泳道组下没有泳道时，必须先创建基线泳道；当泳道组下已创建基线泳道时，只能创建灰度泳道。 BASE，基线泳道。 GRAY，灰度泳道。

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

响应消息 表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" } ] } } ] }