华为云用户手册

请求参数 表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 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind String API类型，固定值“Certificate”，该值不可修改。 枚举值： Certificate items Array of CertItem objects 证书列表。 表4 CertItem 参数 参数类型 描述 metadata MetaCert object 响应数据。 spec SpecCert object 响应数据。 表5 MetaCert 参数 参数类型 描述 id String 证书ID。 name String 证书名称。 表6 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类型，固定值“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

请求示例 更新监控系统配置。 PUT https://{endpoint}/v1/{project_id}/cae/monitor-system/{monitor_system_id} { "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。

响应示例 状态码： 200 请求成功。 { "api_version": "v1", "kind": "NoticeRule", "items": [ { "id": "133da017-423c-4e1c-80be-8c8c71c9b84e", "name": "test", "event_name": "Started", "scope": { "type": "environments", "environments": [ "f3c12180-b34a-42d8-bb5a-12ba0a6b579e" ] }, "trigger_policy": { "trigger_type": "immediately" }, "notification": { "protocol": "email", "endpoint": "123@example.com" "template": "ZH" }, "enable": true } ] }

请求参数 表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的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

请求参数 表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类型，固定值“eip”，该值不可修改。 枚举值： eip spec 否 spec object 修改出入网公网IP带宽信息。 表4 spec 参数 是否必选 参数类型 描述 egress 否 egress object 出网IP信息。 ingress 否 ingress object 入网IP信息。 表5 egress 参数 是否必选 参数类型 描述 bandwidth_size 否 Integer 出网IP带宽。 enabled 否 Boolean 是否关闭出网IP。 表6 ingress 参数 是否必选 参数类型 描述 bandwidth_size 否 Integer 入网IP带宽。 enabled 否 Boolean 是否关闭入网IP。

请求示例 修改出入网带宽以及开闭状态。 PUT https://{endpoint}/v1/{project_id}/cae/eips { "api_version" : "v1", "kind" : "eip", "spec" : { "egress" : { "bandwidth_size" : 50, "enabled" : true }, "ingress" : { "bandwidth_size" : 100, "enabled" : true } } }

请求参数 表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" : "TimerRule", "items" : [ { "id" : "string", "name" : "string", "type" : "start", "env_id" : "string", "cron" : "0 16 17 31 1 ? 2023", "component_number" : 2, "status" : "off", "last_execution_status" : "normal", "effective_range" : "application", "effective_policy" : "onetime", "apps" : [ { "app_id" : "string", "app_name" : "string" } ] }, { "id" : "string", "name" : "string", "type" : "start", "env_id" : "string", "cron" : "0 48 17 ? * * *", "component_number" : 2, "status" : "on", "last_execution_status" : "abnormal", "effective_range" : "environment", "effective_policy" : "periodic" }, { "id" : "string", "name" : "string", "type" : "stop", "env_id" : "string", "cron" : "0 16 17 31 1 ? 2023", "component_number" : 2, "status" : "off", "last_execution_status" : "executing", "effective_range" : "component", "effective_policy" : "onetime", "components" : [ { "component_id" : "string", "component_name" : "string" } ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind String API类型，固定值“TimerRule”，该值不可修改。 枚举值： TimerRule items Array of TimerRuleDetails objects 启停规则列表。 表4 TimerRuleDetails 参数 参数类型 描述 id String 定时启停规则ID，在创建定时启停规则时会忽略。 name String 定时启停规则名称。 type String 定时启停规则的类型：stop/start。 status String 定时启停规则状态（是否开启）：on/off。 env_id String 环境ID。 apps Array of AppInfo objects 定时启停规则所包含的所有应用，只在生效范围为application的时候需要填写。 components Array of ComponentInfo objects 在定时启停规则所包含的所有组件，只在生效范围为component的时候需要填写。 component_number Integer 定时启停规则包含的组件个数，在创建定时启停规则时会忽略。 cron String cron表达式。 effective_range String 定时启停规则生效范围: component/application/environment。 effective_policy String 定时启停规则的定时类别: onetime/periodic。 last_execution_status String 上次执行的状态：abnormal/normal/executing，在创建定时启停规则时会忽略。 表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的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind String API类型，固定值“Agency”，该值不可修改。 枚举值： Agency agencies Array of AgencyItem objects 委托列表。 表4 AgencyItem 参数 参数类型 描述 name String 委托名称，固定值“cae_trust”，该值不可修改。 枚举值： cae_trust

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Agency", "agencies" : [ { "name" : "cae_trust", "roles" : [ " AOM FullAccess", "VPC FullAccess" ], "missing_roles" : [ "ELB FullAccess" ] } ] }

请求参数 表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。

请求示例 修改证书，修改crt（服务器证书内容）和key（服务器私钥内容）。 PUT https://{endpoint}/v1/{project_id}/cae/certificates/{cert_id} { "api_version" : "v1", "kind" : "Certificate", "spec" : { "crt" : "xxx", "key" : "xxx" } }

请求参数 表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 spec 是 UpdateSpecCert object 修改证书请求规格信息。 表4 UpdateSpecCert 参数 是否必选 参数类型 描述 crt 是 String 证书内容。 key 是 String 私钥内容。

请求参数 表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。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Component", "items" : [ { "id" : "610fb1de-5ac6-424e-b910-d7be902575d0", "name" : "demo-xxx", "annotations" : { "version" : "1.0.0", "enterprise_project_id" : "" }, "created_at" : "2022-06-09T07:01:05.323979Z", "updated_at" : "2022-06-09T07:01:05.323979Z", "spec" : { "runtime" : "Docker", "env_id" : "50d18173-5df0-4db4-a2b6-8a428d42146b", "replica" : 1, "source" : { "type" : "image", "url" : "xxx/demo-jar:v2" }, "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "" } }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "image_url" : "xxx/demo-jar:v2", "available_replica" : 1, "job_id" : "251b7d84-c353-416a-864f-5878a94c3d28", "status" : "running", "configuration_operation_id" : "xxx" } } ], "total_count" : 1 }

URI GET /v1/{project_id}/cae/applications/{application_id}/components 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 限制本次返回结果的条数。 offset 否 String 分页偏移位，查询起始位置。 sort_key 否 String 排序字段。 枚举值： created_at updated_at sort 否 String 升降序规则。 枚举值： asc desc

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "ComponentConfiguration", "items" : [ { "type" : "env", "data" : { "spec" : { "envs" : { "TZ" : "Asia/Shanghai" }, "env_references" : [ { "env_name" : "test", "value_from" : { "name" : "test", "reference_type" : "dewSecret" } } ] } }, "operation_id" : "68e82e30-190d-40b2-9680-98a66ccb2f8f", "operated_at" : "2023-02-16T06:35:46.23126Z", "is_activated" : true, "is_using" : false }, { "type" : "volume", "data" : { "spec" : { "volumes" : [ { "volume_id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59", "resource_name" : "test-nacos", "resource_type" : "", "resource_sub_type" : "object_bucket", "mount_info" : [ { "path" : "/tmp", "access_mode" : "ReadWriteMany", "create_time" : "2023-02-16T03:22:59.599Z" } ] }, { "volume_id" : "a061934d-52e3-4b36-aea7-6c51879f84c9", "resource_name" : "test", "resource_type" : "", "resource_sub_type" : "parallel_file_system", "mount_info" : [ { "path" : "/temp", "access_mode" : "ReadWriteMany", "create_time" : "2023-02-16T03:25:08.841Z" } ] } ] } }, "operation_id" : "68e82e30-190d-40b2-9680-98a66ccb2f8f", "operated_at" : "2023-02-16T06:35:46.23126Z", "is_activated" : true, "is_using" : false }, { "type" : "rds", "data" : { "spec" : { "rds_id" : "a5fdee4cf88c4277a68688a014f444bdin01", "rds_port" : "", "rds_address" : "100.xx.xx.xxx", "rds_db_name" : "cae", "rds_password" : "xxx", "rds_username" : "cae" } }, "operation_id" : "b4ce410c-3ac3-40ae-9f11-0c8b98c2df19", "operated_at" : "2023-02-16T02:14:03.416282Z", "is_activated" : true, "is_using" : false }, { "type" : "scaling", "data" : { "spec" : { "scale_strategy" : "mix", "max_replica_count" : 2, "min_replica_count" : 1, "advanced" : { "scaledown_stabilization_seconds" : 300, "scaledown_rate" : 99, "scaleup_stabilization_seconds" : 0, "scaleup_rate" : 4, "disable_scaledown" : false }, "triggers" : [ { "metadata" : { "period_type" : "day", "schedulers" : [ { "cron" : "00 01 * * *", "target_replica" : 2 }, { "cron" : "00 02 * * *", "target_replica" : 1 } ] }, "type" : "cron" }, { "metadata" : { "type" : "Utilization", "value" : "10" }, "type" : "cpu" }, { "metadata" : { "type" : "Utilization", "value" : "20" }, "type" : "memory" } ] } }, "operation_id" : "02c81e5a-251b-4921-878e-a8f78efbadd1", "operated_at" : "2023-02-16T07:03:07.711734Z", "is_activated" : true, "is_using" : false }, { "type" : "access", "data" : { "metadata" : { "annotations" : { "deployBackend" : "k8s", "kubernetes.io/elb.health-check-flag" : "off", "kubernetes.io/elb.lb-algorithm" : "ROUND_ROBIN" } }, "spec" : { "ip" : "100.xx.xx.xxx", "items" : [ { "type" : "ClusterIP", "domain_names" : [ "test-test-config" ], "ports" : [ { "ip" : "", "name" : "loadBalancer-5x095cix5deo", "target_port" : 80, "port" : 8080, "protocol" : "TCP" } ] }, { "type" : "LoadBalancer", "access_control" : { "type" : "white", "ip_list" : [ "1.1.1.1" ] }, "elb_id" : "f5de88cc-64be-4f70-ac17-db745eb12345", "ports" : [ { "ip" : "", "name" : "loadBalancer-0yzp5ud3w2pa", "target_port" : 80, "port" : 8080, "protocol" : "TCP" } ] } ] }, "ref" : { "id" : "f5de88cc-64be-4f70-ac17-db745eb76e67" } }, "operation_id" : "68e82e30-190d-40b2-9680-98a66ccb2f8f", "operated_at" : "2023-02-16T06:35:46.23126Z", "is_activated" : true, "is_using" : true }, { "type" : "lifecycle", "data" : { "api_version" : "v1", "kind" : "lifecycle", "spec" : { "postStart" : { "exec" : { "command" : [ "/bin/sh", "-c", "echo service start" ] } }, "preStop" : { "exec" : { "command" : [ "/bin/sh", "-c", "echo service end" ] } } } }, "operation_id" : "69bcf986-6f83-4f43-9ca1-595684ba0748", "operated_at" : "2023-02-16T07:05:05.610439Z", "is_activated" : true, "is_using" : false }, { "type" : "cse", "data" : { "spec" : { "cse_id" : "25779525-1aac-44be-abda-f9164f1b41b8", "config_center_addr" : "https://192.168.1.xxx:30103,https://192.168.1.xxx:30103", "service_center_addr" : "https://192.168.1.xxx:30100,https://192.168.1.xxx:30100" } }, "operation_id" : "945305ee-8be5-4826-9215-45a0b545ed13", "operated_at" : "2023-02-16T07:10:38.937075Z", "is_activated" : true, "is_using" : false }, { "type" : "healthCheck", "data" : { "spec" : { "livenessProbe" : { "httpGet" : { "path" : "", "port" : 80, "scheme" : "HTTP" }, "initialDelaySeconds" : 0, "timeoutSeconds" : 1, "periodSeconds" : 10, "successThreshold" : 1, "failureThreshold" : 3 }, "readinessProbe" : { "httpGet" : { "path" : "", "port" : 80, "scheme" : "HTTP" }, "initialDelaySeconds" : 0, "timeoutSeconds" : 1, "periodSeconds" : 10, "successThreshold" : 1, "failureThreshold" : 3 }, "startupProbe" : { "httpGet" : { "path" : "", "port" : 80, "scheme" : "HTTP", "httpHeaders" : [ { "name" : "x-auth-token", "value" : "xxx" } ] }, "initialDelaySeconds" : 0, "timeoutSeconds" : 1, "periodSeconds" : 10, "successThreshold" : 1, "failureThreshold" : 3 } } }, "operation_id" : "2361fba9-ee7e-405d-8b05-afc945a43e65", "operated_at" : "2023-02-16T07:07:23.193231Z", "is_activated" : true, "is_using" : false }, { "type" : "customMetric", "data" : { "metadata" : { "annotations" : { "deployBackend" : "k8s" }, "created_at" : "0001-01-01T00:00:00Z", "updated_at" : "0001-01-01T00:00:00Z" }, "spec" : { "port" : 2112, "path" : "/metrics", "metrics" : [ "myapp_processed_ops_total" ] }, "ref" : { "id" : "17b7f411-5a34-4319-abfc-34f6cf774a44" } }, "operation_id" : "a79a7c8d-6d5e-41ec-892b-973d11f5e835", "operated_at" : "2023-08-30T11:21:22.222476Z", "is_activated" : false, "is_using" : false } ] }

URI GET /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 Query参数 参数 是否必选 参数类型 描述 displayMode 否 String 显示模式，当前只支持“latestEffective”，即只显示最后一次已生效配置。

请求参数 表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。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本，固定值“v1”，该值不可修改。 枚举值： v1 kind 是 String API类型，固定值“Volume”，该值不可修改。 枚举值： Volume spec 是 VolumeSpec object volume规格信息。 表4 VolumeSpec 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型，当前只支持“obs”和“sfs”。 resource_sub_type 是 String 对象存储类型。 枚举值： object_bucket parallel_file_system sfs3.0 resources 是 Array of strings 云存储 名称。 resources_credentials 否 Array of ResourcesCredential objects 云存储和授权凭证，获取环境列表接口响应中env_category字段为v2时需添加该字段的值。 表5 ResourcesCredential 参数 是否必选 参数类型 描述 access 否 String 用户access key，当前access key应该包含访问授权云存储的权限。 secret 否 String 用户secret key，当前secret key应该包含访问授权云存储的权限。

请求示例 授权云存储，云存储类型为“obs”，存储桶名称为“test-bucket”。 POST https://{endpoint}/v1/{project_id}/cae/volumes { "api_version" : "v1", "kind" : "Volume", "spec" : { "resource_type" : "obs", "resource_sub_type" : "object_bucket", "resources" : [ "test-bucket" ], "resources_credentials" : [ { "access" : "xxx", "secret" : "xxx", "resources" : [ "test-bucket" ] } ] } }

URI PUT /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。

请求示例 更新组件代码源为源码仓库，组件名称“demo”，版本“1.0.0”，选择GitLab源码仓库，运行时为Java8。 PUT https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id} { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "demo", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "xxx", "dockerfile_path" : "xxx" } }, "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 } } 更新组件代码源为镜像，组件名称“demo”，版本“1.0.0”，选择名称为“cae-demo”的镜像，运行时为Docker。 PUT https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id} { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "demo", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Docker", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "xxx" } }, "source" : { "type" : "image", "url" : "xxx/cae-demo:v1" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } } 更新组件代码源为软件包，组件名称“demo”，版本“1.0.0”，在OBS对象存储中选择名称为“forecast-1.0.0.jar”的软件包，运行时为Java8。 PUT https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id} { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "demo", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "openjdk:8u181-jdk-alpine", "dockerfile_content" : "xxx" } }, "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 } }

请求参数 表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类型，固定值“Domain”，该值不可修改。 枚举值： Domain metadata 是 CreateMetaDomain object 请求数据。 表4 CreateMetaDomain 参数 是否必选 参数类型 描述 name 是 String 域名 名称。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 枚举值： v1 items Array of DomainItem objects 域名列表。 kind String API类型，固定值“Domain”，该值不可修改。 表6 DomainItem 参数 参数类型 描述 metadata MetaDomain object 响应数据。 表7 MetaDomain 参数 参数类型 描述 id String 域名ID。 name String 域名名称。 created_at String 创建时间。