华为云用户手册

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token ，请参考《 统一身份认证 服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Application", "items" : [ { "id" : "88275aa8-38ae-4428-a269-6c5f41d91491", "name" : "test", "created_at" : "2022-05-30T15:09:25.642149Z", "updated_at" : "2022-05-30T15:09:25.642149Z" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind String API类型，固定值“Application”，该值不可修改。 枚举值： Application items Array of ApplicationItem objects 应用列表。 表4 ApplicationItem 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 created_at String 创建时间。 updated_at String 更新时间。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "ComponentInstance", "items" : [ { "id" : "d59a645b-730d-4a1a-951f-822a71dcdb9d", "name" : "test-image-5787bf845c-wzz99", "status" : "creating" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind String API类型，固定值“ComponentConfiguration”，该值不可修改。 枚举值： ComponentConfiguration items Array of Instance objects 组件实例列表。 表4 Instance 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 status String 实例状态。 枚举值： creating running abnormal failed terminating

URI GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "NoticeRule", "spec" : { "name" : "test", "event_name" : "Started", "scope" : { "type" : "environments", "environments" : [ "f3c12180-b34a-42d8-bb5a-12ba0a6b579e" ] }, "trigger_policy" : { "trigger_type" : "immediately" }, "enable" : true } }

请求示例 修改事件通知规则。 POST https://{endpoint}/v1/{project_id}/cae/notice-rules/{rule_id} { "api_version" : "v1", "kind" : "NoticeRule", "spec" : { "event_name" : "Started", "scope" : { "type" : "environments", "environments" : [ "f3c12180-b34a-42d8-bb5a-12ba0a6b579e" ] }, "trigger_policy" : { "trigger_type" : "immediately" }, "enable" : true } }

请求示例 创建监控系统配置。 POST https://{endpoint}/v1/{project_id}/cae/monitor-system { "api_version" : "v1", "kind" : "MonitorSystem", "spec" : { "type" : "opentelemetry", "access_token" : "******", "apm_application" : "default", "image_pull_policy" : "Always", "version" : "1.32.0.14", "instrumentation" : "automatic" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 否 String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind 否 String API类型，固定值“MonitorSystem”，该值不可修改。 枚举值： MonitorSystem spec 否 MonitorSystemRequestBodySpec object 创建或更新监控系统配置。 表4 MonitorSystemRequestBodySpec 参数 是否必选 参数类型 描述 type 是 String 采集方式。 枚举值： opentelemetry apm2 instrumentation 是 String 探针注入方式。 枚举值： manual automatic access_key 否 String apm2访问密钥Key。 access_value 否 String apm2访问密钥value。 access_token 否 String apm2 opentelemetry接入token。 apm_application 是 String apm2应用。 version 是 String 增强型探针/opentelemetry探针版本。 image_pull_policy 是 String 探针镜像更新策略。 枚举值： Always IfNotPresent

响应示例 状态码： 200 请求成功。 { "api_version": "v1", "kind": "Component", "metadata": { "id": "cac09548-047f-46c4-abbd-a6a652305565", "name": "test-code", "annotations": { "log_group_id": "5b13213a-84f8-4b72-8ca5-530e15cc1402", "log_stream_id": "6ddf6c71-4767-46db-98a2-fe5fb301b366", "version": "1.0.0" }, "created_at": "2023-02-13T02:38:22.689607114Z", "updated_at": "2023-02-13T02:38:22.689607114Z" }, "spec": { "runtime": "Java8", "env_id": "9819b3f5-dd08-44ff-ba88-eb38e435594c", "replica": 1, "source": { "type": "code", "sub_type": "GitLab", "url": "http://xxx@cpe.gitlab.com:8090/xxx/cae-backend.git", "code": { "branch": "master", "auth_name": "gitlab-xxx", "namespace": "em1n" } }, "build": { "archive": { "artifact_namespace": "xxx" }, "parameters": { "base_image": "openjdk:8u181-jdk-alpine" "dockerfile_path": "./Dockerfile" } }, "resource_limit": { "cpu_limit": "500m", "memory_limit": "1Gi" }, "available_replica": 0, "status": "created" }, "configurations": [ { "type": "volume", "data": { "spec": { "volumes": [ { "volume_id": "84f2e74c-c684-4933-bcf6-b6c230386049", "resource_name": "test-cae", "resource_type": "obs", "resource_sub_type": "object_bucket", "umask": "0027", "mount_info": [ { "path": "/tmp/test", "sub_path": "", "access_mode": "ReadWriteMany", "create_time": "2024-06-07T03:06:46.094Z" } ] } ] } }, "operation_id": "c2120961-df90-4a77-8195-357ad21505b2", "operated_at": "2024-06-11T07:44:22.856241Z", "is_activated": false }, { "type": "access", "data": { "metadata": { "annotations": { "deployBackend": "k8s" }, "created_at": "0001-01-01T00:00:00Z", "updated_at": "0001-01-01T00:00:00Z" }, "spec": { "ip": "", "elb_private_ip": "", "items": [ { "uid": "4ad7dba0-50d4-420a-9a91-be2de4eb41df", "type": "LoadBalancer", "metadata": { "annotations": { "kubernetes.io/elb.health-check-flag": "on", "kubernetes.io/elb.health-check-option": "{\"protocol\":\"TCP\",\"delay\":\"5\",\"timeout\":\"10\",\"max_retries\":\"3\"}" }, "created_at": "0001-01-01T00:00:00Z", "updated_at": "0001-01-01T00:00:00Z" }, "elb_id": "defaultElbID", "access_control": null, "public_ip": "100.93.14.168", "private_ip": "", "ports": [ { "ip": "", "name": "", "target_port": 80, "port": 80, "protocol": "TCP", "default_certificate": "" } ], "default_certificate": "" } ] }, "ref": { "id": "ac24d721-f1e0-47da-ab9c-bad1d3b874ea" } }, "operation_id": "c2120961-df90-4a77-8195-357ad21505b2", "operated_at": "2024-06-11T07:44:21.969021Z", "is_activated": false } ], status:{ "job_id":"xxx" } }

请求示例 使用源码仓库创建组件，组件名称“test-code”，版本“1.0.0”，选择GitLab源码仓库，运行时为Java8，并配置访问方式负载均衡。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/component-with-configurations { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "test-code", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "openjdk:8u181-jdk-alpine", "dockerfile_path" : "./Dockerfile" } }, "source" : { "type" : "code", "sub_type" : "GitLab", "url" : "https://xxx:8090/xxx/cae-frontend.git", "code" : { "branch" : "master", "auth_name" : "gitlab-xxx", "namespace" : "em1n" } }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 }, "configurations" : [ { "type" : "access", "data" : { "spec" : { "items" : [ { "type" : "LoadBalancer", "elb_id" : "defaultElbID", "ports" : [ { "target_port" : 80, "port" : 80, "protocol" : "TCP" } ] } ] } } } ] } 使用镜像创建组件，组件名称“test-image”，版本“1.0.0”，选择nginx镜像，运行时为Docker，并配置访问方式负载均衡。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/component-with-configurations { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "test-image", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Docker", "source" : { "type" : "image", "url" : "nginx:stable-alpine-perl" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 }, "configurations" : [ { "type" : "access", "data" : { "spec" : { "items" : [ { "type" : "LoadBalancer", "elb_id" : "defaultElbID", "ports" : [ { "target_port" : 80, "port" : 80, "protocol" : "TCP" } ] } ] } } } ] } 使用软件包创建组件，组件名称“test-jar”，版本“1.0.0”，在OBS对象存储中选择名称为“forecast-1.0.0.jar”的软件包，运行时为Java8，并配置访问方式负载均衡。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/component-with-configurations { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "test-jar", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "openjdk:8u181-jdk-alpine", "dockerfile_content" : "FROM java:8 \\nADD forecast-1.0.0.jar \\nEXPOSE 8080 \\nENTRYPOINT [\"java\",\"-jar\",\"forecast-1.0.0.jar\"]" } }, "source" : { "type" : "softwarePackage", "sub_type" : "BinObs", "url" : "https://xxx.obs.region.xxx.huawei.com/xxx/forecast-1.0.0.jar" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 }, "configurations" : [ { "type" : "access", "data" : { "spec" : { "items" : [ { "type" : "LoadBalancer", "elb_id" : "defaultElbID", "ports" : [ { "target_port" : 80, "port" : 80, "protocol" : "TCP" } ] } ] } } } ] }

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Certificate", "items" : [ { "metadata" : { "id" : "d66c5baf-3ab7-49da-92d6-a44aaad1997d", "name" : "test" }, "spec" : { "crt" : "xxx", "key" : "xxx", "created_at" : "2023-02-28T07:19:49.610098Z" } } ] }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind String API类型，固定值“Certificate”，该值不可修改。 枚举值： Certificate items Array of CertItem objects 证书列表。 表7 CertItem 参数 参数类型 描述 metadata MetaCert object 响应数据。 spec SpecCert object 响应数据。 表8 MetaCert 参数 参数类型 描述 id String 证书ID。 name String 证书名称。 表9 SpecCert 参数 参数类型 描述 crt String 证书内容。 key String 私钥内容。 created_at String 创建时间。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind 是 String API类型，固定值“Certificate”，该值不可修改。 枚举值： Certificate metadata 是 CreateMetaCert object 创建证书请求数据。 spec 是 CreateSpecCert object 创建证书请求规格信息。 表4 CreateMetaCert 参数 是否必选 参数类型 描述 name 是 String 证书名称。 表5 CreateSpecCert 参数 是否必选 参数类型 描述 crt 是 String 证书内容。 key 是 String 私钥内容。

请求示例 创建证书，证书名称“test”，填写crt（服务器证书内容）和key（服务器私钥内容）。 POST https://{endpoint}/v1/{project_id}/cae/certificates { "api_version" : "v1", "kind" : "Certificate", "metadata" : { "name" : "test" }, "spec" : { "crt" : "xxx", "key" : "xxx" } }

URI DELETE /v1/{project_id}/cae/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

URI POST /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求示例 对组件执行指定操作，如部署、重启、停止、启动、生效配置。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/action { "api_version" : "v1", "kind" : "Action", "metadata" : { "name" : "deploy/restart/stop/start/configure", "annotations" : { "version" : "1.0.0" } } } 对组件执行升级操作，升级后版本号为“1.0.1”。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/action { "api_version" : "v1", "kind" : "Action", "metadata" : { "name" : "upgrade", "annotations" : { "version" : "1.0.1" } }, "spec" : { "source" : { "type" : "image", "url" : "nginx:stable-alpine-perl" } } } 对组件执行伸缩操作，将实例数扩容到2。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/action { "api_version" : "v1", "kind" : "Action", "metadata" : { "name" : "scale", "annotations" : { "version" : "1.0.0" } }, "spec" : { "replica" : 2 } } 对组件执行回滚操作。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/action { "api_version" : "v1", "kind" : "Action", "metadata" : { "name" : "rollback", "annotations" : { "version" : "1.0.0" } }, "spec" : { "snapshot_index" : 1 } }

请求示例 修改定时启停规则，修改策略名称为“test-2”，是一个启动策略，生效组件范围涉及部分组件，触发策略为“执行一次”。 PUT https://{endpoint}/v1/{project_id}/cae/timer-rules/{rule_id} { "api_version" : "v1", "kind" : "TimerRule", "spec" : { "name" : "test-2", "type" : "start", "cron" : "0 55 16 22 2 ? 2023", "status" : "on", "env_id" : "c41a8e9f-5447-406a-8783-85885f3870a3", "effective_range" : "component", "effective_policy" : "onetime", "components" : [ { "component_id" : "10f7b6be-5dc2-4fb7-b62c-e8f362dfdabf", "component_name" : "addd" }, { "component_id" : "3f3041f9-5063-40c9-94ee-8473517b3956", "component_name" : "demo-frontend-1676360408" } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind 是 String API类型，固定值“TimerRule”，该值不可修改。 枚举值： TimerRule spec 是 UpdateTimerRuleDetails object 修改启停规则规格信息 表4 UpdateTimerRuleDetails 参数 是否必选 参数类型 描述 name 是 String 定时启停规则名称。 type 是 String 定时启停规则的类型：stop/start。 status 是 String 定时启停规则状态（是否开启）：on/off。 apps 否 Array of AppInfo objects 定时启停规则所包含的所有应用，只在生效范围为application的时候需要填写。 components 否 Array of ComponentInfo objects 在定时启停规则所包含的所有组件，只在生效范围为component的时候需要填写。 cron 是 String cron表达式。 effective_range 是 String 定时启停规则生效范围: component/application/environment。 effective_policy 是 String 定时启停规则的定时类别: onetime/periodic。 表5 AppInfo 参数 是否必选 参数类型 描述 app_id 否 String 应用ID。 app_name 否 String 应用名称。 表6 ComponentInfo 参数 是否必选 参数类型 描述 component_id 否 String 组件ID。 component_name 否 String 组件名称。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Environment", "items" : [ { "id" : "5d3d1e90-2f5d-4ef1-958b-3fc1ed0b0898", "name" : "test", "version" : "1.2.0", "job_id" : "15cbf4ff-e6a8-4504-a5e0-574b9c21493a", "status" : "finish", "annotations" : { "cluster_id" : "2177808d-a78e-11ed-be73-0255ac100b0a", "enterprise_project_id" : "0", "env_category" : "v2", "group_name" : "xxx", "inbound_eip_addr" : "100.xx.xx.xxx", "namespace" : "79c4xxxf5f3a4xxxda92601xxx64b1e8c-test", "public_elb_id" : "da9e107e-bd25-412f-9546-563ed11ae34c", "type" : "exclusive", "vpc_id" : "09902850-9454-4715-9764-018f0c3701fd" }, "created_at" : "2023-02-08T08:49:34.000737Z", "updated_at" : "2023-02-08T08:49:34.000737Z" } ] }

URI DELETE /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最大长度：16384 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。