请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token ，请参考《 统一身份认证 服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 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" : "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”，即只显示最后一次已生效配置。

操作步骤 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 图1 选择组件 单击“健康检查”模块中的“编辑”。 在右侧弹框中可选择配置“存活探针”、“就绪探针”和“启动探针”。目前支持三种探针，可同时开启不同探针。 存活探针：针对应用实例进行健康检查，检测应用实例是否已经启动，此时处于启动过程中。单击“存活探针”后的进行检查方式配置。 就绪探针：针对应用实例进行健康检查，检测应用实例是否完成启动，此时处于可对外提供服务状态。单击“就绪探针”后的进行检查方式配置。本示例需打开就绪探针。 启动探针：针对应用实例进行健康检查，检测应用实例是否稳定运行，此时失败CAE会重启应用实例。单击“启动探针”后的进行检查方式配置。 图2 就绪探针 选择其中一种检查方式，并配置相应的参数，具体参数请参考表1、表2。 HTTP请求检查：通过向实例发送HTTP请求检查健康情况。通过HTTP访问获得的HTTP状态码位于[200,399]之间，则认为访问成功，实例健康；否则认为失败，实例不健康。 TCP端口检查：通过向实例发送一个TCP Socket来检查实例的健康情况。如果可以建立连接，则认为实例健康。 执行命令检查：通过在实例中执行探针检测命令来检查实例的健康情况。如果连接失败，则认为不健康。 表1 检查方式配置项参数 检查方式 配置项参数 参数说明 HTTP请求检查 端口 建立HTTP GET使用的端口。 路径 建立HTTP GET使用的路径。 协议 选择HTTP或HTTPS协议。 请求头 请求中自定义的HTTP头。 TCP端口检查 端口 用户指定端口，用于TCP连接。本示例选用TCP端口检查。 执行命令 执行命令 添加执行命令，可单击“添加执行命令”添加多条执行命令。 说明： 添加执行命令时，命令行后不允许有空格。 表2 三种检查方式公共配置参数 配置项参数 参数说明 检测周期 探测时间间隔。 默认值为10秒，最小值为1秒。本示例使用默认值。 延迟时间 最长允许延迟时间。 默认值为0秒，最小值为0秒。本示例使用默认值。 说明： 如果用户在容器启动之前配置健康检查，建议延迟时间增长至3分钟。 超时时间 配置探测的超时时间。 默认值为1秒，最小值为1秒。本示例使用默认值。 成功阈值 探测连续几次成功表示成功。 默认值为1，最小值为1，存活探针和启动探针必须为1。本示例使用默认值。 最大失败次数 探测连续几次失败表示失败。 默认值为3，最小值为1。本示例使用默认值。 单击“确定”完成配置。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。 升级组件后，在“组件事件”页面中观察，“组件实例健康”事件为正常，则表示组件升级成功。 图3 组件健康检查

注意事项 单独使用存活探针时，如出现网络波动或程序启动过慢的情况，会导致实例持续被重启，且实例一直处于未就绪的状态。 有如下解决方案： 与启动探针配合使用，具体操作请参见启动探针与存活探针配合工作。 使用时将“最大失败次数”调大，增加容错率，并增大“延迟时间”，保证程序在启动后再接受存活探针的检测。 检查成功：对于在健康检查中设置的请求返回状态码200。 检查失败：对于在健康检查中设置的请求返回状态码非200，且连续失败次数达到设置的“最大失败次数”。

配置项说明 表1 list配置项说明 参数 类型 是否必选 示例 说明 type String 是 type: "list" 配置项类型。 name String 是 name:"intervalColors" 双向绑定list名称。 label Object 否 label: { "zh_CN": "中文标签", "en_US": "English Label" } 配置项的标签，需要国际化。 listFixed Boolean 否 listFixed: true 列表个数固定，不展示新增、删除功能，默认为true展示。 labelOnce Boolean 否 labelOnce: true 仅在list首项展示一次label。 设置为true时，只有list中第一项展示list label。 设置为false时，每一项都展示label。 showIndex Boolean 否 showIndex: true label末尾显示计数。 设置为true时，label末尾进行计数(index+1)展示为label1，label2…。 设置false时，每一个label内容相同。 displayMode String 否 displayMode: “box”displayMode: “simple” 显示为下拉框中或平铺。 box：显示在下拉框中。 simple：直接显示。 events Object 是 events: { addItemFunc: function (vm, index) { return { size: 1, color: 'rgba(11,129,246,1)'} }, itemDelCallBack: function (values) { if (values && values.length) { values[values.length - 1].size = 1; } }, }, 增加和删除list中一项。默认有增加删除功能，所以需要添加addItemFunc和itemDelCallBack函数。 如果noAdd为true，不需要添加。 childItems Array 是 childItems: [ { type: "colorpicker", name: "color", value: "rgba(11,129,246,1)", width: 26, showInput: false, }, { type: "input-number", name: "number", prop: "number", label: "序列号" originFrom: "advanceEditvm", value: "123", width: 74, labelWidth: 20, }] list中每一项含有的基础配置项。 基础配置项中可以通过加入width调整一行中的占比，例如3个options的width是20,30,30，三个配置项就会出现在一行。如果width是20,30,70，前两个会在一行，第三个占第二行的70%。 如果不加入width或者width占比为100，就会单独占一行。 基础配置项中也增加了labelWidth，在有label的情况下可以通过输入数字控制label的宽度（单位为px）。 tip Object 否 tip: { zh_CN: "当前排行榜展示的数据行数", en_US: "Number of data rows displayed in the current ranking page.", } label后会显示info提示。 allowNone Boolean 否 allowNone: true, 是否允许删除到空。默认为false，不允许删除到空。 helpLink String 否 helpLink: "http://..." 使用helpIcon。

配置示例 配置后效果，如图1所示。 { type: "list", name: "commProps.rowCusBg", displayMode: "simple", labelOnce: true, allowNone: true, label: { zh_CN: "背景色", en_US: "Background Color" }, helpLink: "https://***.html", childItems: [ { type: "colorpicker", name: "color", originFrom: "advanceEditvm", value: "", width: 26, showInput: false, }, { type: "string", name: "row", originFrom: "advanceEditvm", label: { zh_CN: "序列号", en_US: "Serial Number" }, value: "", width: 74, }, ],}, 图1 list配置后效果

如何重置 MRS Kafka数据？ 删除Kafka topic信息即重置Kafka数据，具体命令请参考： 删除topic：kafka-topics.sh --delete --zookeeper ZooKeeper集群业务IP:2181/kafka --topic topicname 查询所有topic：kafka-topics.sh --zookeeper ZooKeeper集群业务IP:2181/kafka --list 执行删除命令后topic数据为空则此topic会立刻被删除，如果有数据则会标记删除，后续Kafka会自行进行实际删除。 父主题： 组件配置类

编辑已绑定配置文件 选择“应用配置”。 在已绑定的配置文件列表中，选择待编辑的配置文件。 单击“操作”列的“编辑”。 请参考下表设置绑定配置文件参数。 参数名称 参数说明 配置分组 配置文件所在分组。 配置文件名称 挂载到虚拟机挂载路径下的用户自定义配置文件名称（例如：config.yaml）。 虚拟机挂载路径 挂载配置文件的相对路径（例如：./config）。其上级工作目录为/opt/application/{CAS_INSTANCE_NAME}/{CAS_INSTANCE_VERSION}/{CAS_INSTANCE_ID}，存储了部署组件所需的环境依赖、安装/启动/停止等脚本以及所需部署的软件包。 {CAS_INSTANCE_NAME}是组件实例名称。 {CAS_INSTANCE_VERSION}是组件实例版本号。 {CAS_INSTANCE_ID}是组件实例ID。 单击“确定”。