华为云用户手册

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

请求示例 创建VPC访问CAE环境配置。 POST https://{endpoint}/v1/{project_id}/cae/vpc-ingress { "api_version" : "v1", "kind" : "VpcIngress", "items" : [ { "vpc_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaac", "subnet_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaad" } ] }

请求参数 表2 请求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。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 否 String API版本，固定值“v1”，该值不可修改。 kind 否 String API类型，固定值“VpcIngress”，该值不可修改。 items 否 Array of VpcIngressRequestItem objects VPC访问CAE环境配置。 表4 VpcIngressRequestItem 参数 是否必选 参数类型 描述 vpc_id 否 String 所选VPC ID。 subnet_id 否 String 所选VPC子网ID。

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

请求参数 表2 请求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" : "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”，该值不可修改。 kind String API类型，固定值“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" } ] }

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值。 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”，该值不可修改。 kind String API类型，固定值“ComponentConfiguration”，该值不可修改。 items Array of Instance objects 组件实例列表。 表4 Instance 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 status String 实例状态。

响应示例 状态码：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 } }

请求示例 修改事件通知规则。 PUT 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 } }

响应示例 状态码：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" } } ] }

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

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“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值。 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”，该值不可修改。 kind 是 String API类型，固定值“Certificate”，该值不可修改。 metadata 是 CreateMetaCert object 创建证书请求数据。 spec 是 CreateSpecCert object 创建证书请求规格信息。 表4 CreateMetaCert 参数 是否必选 参数类型 描述 name 是 String 证书名称。 表5 CreateSpecCert 参数 是否必选 参数类型 描述 crt 是 String 证书内容。 key 是 String 私钥内容。

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值。 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 } }

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

响应示例 状态码：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" } ] }

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

恢复归档文件 勾选一个或多个归档存储类型的音视频文件，单击“恢复归档文件”。 弹出“恢复已被归档的文件”，如图3所示。 图3 恢复已被归档的文件 参数配置说明，如表2所示。 表2 参数说明 参数 说明 恢复模式 归档存储恢复为标准存储的恢复模式。 包含如下选项： 快速取回模式：取回时间约为6分钟。 标准取回模式：取回时间约为3~5小时。 恢复方式 归档存储恢复为标准存储的恢复方式。 包含如下取值： 临时取回：临时取回音视频文件后，将会生成一份标准存储类型的对象副本。此时用户可以访问OBS的音视频文件资源，但是临时恢复的归档文件不允许执行转码操作。 该副本具备有效期，会在有效期结束后自动删除。实际音视频文件还是归档存储类型。 永久取回：永久取回音视频文件，变更为标准存储类型。 副本有效期 临时取回归档存储类型的音视频文件，生成标准存储类型对象副本的保存时间。 单位：天。取值范围：1-30。 单击“确定”，完成归档存储文件的恢复操作。 到达取回时间后，刷新音视频管理界面。 临时取回的方式，可以看到音视频的存储类型为“归档存储”。 永久取回的方式，可以看到音视频的存储类型为“标准存储”。

Linux系统主机配置 为确保Linux系统主机连通性验证成功，Linux主机需确保安装Python并开启SELinux机制，目标主机需要满足以下条件。 目标主机安装Python： 需安装Python2.6及以上版本，如果已安装Python2.6以下版本，需要在主机上安装以下模块，各系统安装命令如下： Ubuntu系统 sudo apt install python-minimal python-simplejson Centos或Euler系统 sudo yum install python-minimal python-simplejson ln -s /usr/bin/python2 /usr/bin/python 采用Apt或者Yum安装工具时，请确保已配置可用的源。 主机开启SELinux机制并安装“libselinux-python”模块： 查看SELinux状态，命令如下： /usr/sbin/sestatus “SELinux”状态参数值所对应的模式： SELinux=disabled：未开启。 SELinux=enforcing：强制模式，表示所有违反安全策略的行为都将被禁止。 SELinux=permissive：宽容模式，表示所有违反安全策略的行为不被禁止，但是会在日志中作记录。 若SELinux=disabled，则主机未开启该机制，需修改SELinux状态，步骤如下： 编辑SELinux的config文件，执行命令： vi /etc/selinux/config 根据实际情况选择修改SELinux参数为参数： SELinux=enforcing：强制模式，表示所有违反安全策略的行为都将被禁止。 SELinux=permissive：宽容模式，表示所有违反安全策略的行为不被禁止，但是会在日志中作记录。 修改完成按键盘“Esc键”，退出编辑模式，执行下面的命令，保存并退出文件。 wq 在根目录下创建隐藏文件.autorelabel，执行下面的命令后，重启Linux主机。 touch /.autorelabel 在主机上安装“libselinux-python”模块，各系统安装命令如下： Ubuntu系统 sudo apt install libselinux-python Centos或Euler系统 sudo yum install libselinux-python

添加目标主机 进入基础资源管理。 单击已创建的集群名称，进入该集群页面的“目标主机”页签。 单击“添加或导入主机”，“选择添加方式”选择“通过IP手动添加”。 当主机集群的主机连通方式为“直连模式”时，只需新增目标主机即可。填写以下信息后，单击“确定”，完成目标主机的创建。 表1 Linux系统目标主机参数说明 参数项 是否必填 说明 主机名 是 请输入自定义的目标主机名称。 仅支持3-128位数字、中文、英文字母或-_.符号。 IP 是 请输入目标主机所绑定的公网IP地址。支持IPv4或IPv6格式。 操作系统 是 不可更改，默认为当前主机集群的操作系统。 请参见Linux系统主机配置对目标主机进行配置，避免连通性认证失败。 认证方式 是 请根据实际情况选择密码或密钥进行认证。 密码：页面显示“用户名”与“密码”。以E CS 为例，输入的是ECS的用户名及密码。 密钥：页面显示“用户名”与“密钥”。密钥的生成与获取方式请参考获取Linux密钥。 SSH端口 是 推荐使用22端口，支持自定义端口。 安装 AOM -ICAgent复选框 否 若勾选该选项，可免费在主机上安装并使用AOM-ICAgent，实现指标监控、日志查询、告警功能。其中，ICAgent仅限华为云Linux主机，安装前请参照创建/使用委托配置委托。 表2 Windows系统目标主机参数说明 参数项 是否必填 说明 主机名 是 请输入自定义的目标主机名称。 仅支持3-128位数字、中文、英文字母或-_.符号。 IP 是 请输入目标主机所绑定的公网IP地址。支持IPv4或IPv6格式。 操作系统 是 不可更改，默认为当前主机集群的操作系统。 请参见Windows系统主机配置对目标主机进行配置，避免连通性认证失败。 认证方式 是 Windows系统代理机仅支持密码认证。以ECS为例，输入的是ECS的用户名及密码。 winrm端口 是 推荐使用5986端口，支持自定义端口。 当主机集群的主机连通方式为“代理模式”时，需要先新增代理主机再增加目标主机。填写以下信息后，单击“确定”，完成代理主机和目标主机的创建。 新增代理主机。 表3 Linux系统代理主机参数说明 参数项 是否必填 说明 主机名 是 请输入自定义的代理主机名称。 仅支持3-128位数字、中文、英文字母或-_.符号。 IP 是 请输入代理主机所绑定的公网IP地址。支持IPv4或IPv6格式。 操作系统 是 不可更改，默认为当前主机集群的操作系统。 请参见Linux系统主机配置对目标主机进行配置，避免连通性认证失败。 认证方式 是 请根据实际情况选择密码或密钥进行认证。 密码：页面显示“用户名”与“密码”。以ECS为例，输入的是ECS的用户名及密码。 密钥：页面显示“用户名”与“密钥”。密钥的生成与获取方式请参考获取Linux密钥。 SSH端口 是 推荐使用22端口，支持自定义端口。 安装AOM-ICAgent复选框 否 若勾选该选项，可免费在主机上安装并使用AOM-ICAgent，实现指标监控、日志查询、告警功能。其中，ICAgent仅限华为云Linux主机，安装前请参照创建/使用委托配置委托。 表4 Windows系统代理主机参数说明 参数项 是否必填 说明 主机名 是 请输入自定义的代理主机名称。 仅支持3-128位数字、中文、英文字母或-_.符号。 IP 是 请输入代理主机所绑定的公网IP地址。支持IPv4或IPv6格式。 操作系统 是 不可更改，默认为当前主机集群的操作系统。 请参见Windows系统主机配置对目标主机进行配置，避免连通性认证失败。 认证方式 是 Windows系统代理机仅支持密码认证。以ECS为例，输入的是ECS的用户名及密码。 winrm端口 是 推荐使用5986端口，支持自定义端口。 新增目标主机。 表5 Linux系统目标主机参数说明 参数项 是否必填 说明 主机名 是 请输入自定义的目标主机名称。 仅支持3-128位数字、中文、英文字母或-_.符号。 代理主机 是 请选择目标代理主机为无法连接公网的目标主机进行网络代理。 IP 是 请输入目标主机IP地址。支持IPv4或IPv6格式。 操作系统 是 不可更改，默认为当前主机集群的操作系统。 请参见Linux系统主机配置对目标主机进行配置，避免连通性认证失败。 认证方式 是 请根据实际情况选择密码或密钥进行认证。 密码：页面显示“用户名”与“密码”。以ECS为例，输入的是ECS的用户名及密码。 密钥：页面显示“用户名”与“密钥”。密钥的生成与获取方式请参考获取Linux密钥。 SSH端口 是 推荐使用22端口，支持自定义端口。 安装AOM-ICAgent复选框 否 若勾选该选项，可免费在主机上安装并使用AOM-ICAgent，实现指标监控、日志查询、告警功能。其中，ICAgent仅限华为云Linux主机，安装前请参照创建/使用委托配置委托。 表6 Windows系统目标主机参数说明 参数项 是否必填 说明 主机名 是 请输入自定义的目标主机名称。 仅支持3-128位数字、中文、英文字母或-_.符号。 代理主机 是 请选择目标代理主机为无法连接公网的目标主机进行网络代理。 IP 是 请输入目标主机的IP地址。支持IPv4或IPv6格式。 操作系统 是 不可更改，默认为当前主机集群的操作系统。 Windows系统：请参见Windows系统主机配置对目标主机进行配置，避免连通性认证失败。 认证方式 是 Windows系统代理机仅支持密码认证。以ECS为例，输入的是ECS的用户名及密码。 代理机转发端口 是 该端口为进行Windows代理机配置时的监听端口，推荐使用54端口，支持自定义端口。 您也可单击“添加或导入主机”，“选择添加方式”选择“导入已购ECS”，将自申请的华为云弹性云服务器作为目标主机或代理主机。 使用导入已购ECS功能时，要满足以下条件才能成功导入主机： 实例正在运行中。 实例与主机集群操作系统一致。 在官方资源池的代理场景下，代理主机必须为公网IP。 实例已导入为目标主机，不能导入为代理主机。 在代理机场景下，需要先配置代理主机才能正常使用目标主机。 进行主机连通性验证。 主机添加成功后开始自动进行连通性验证，如果主机连通性验证失败，请单击“失败”，根据弹框中显示的失败原因或单击“查看解决方案”进行排查故障。

查看应用 介绍如何查看已创建应用的信息，该信息包括应用的部署记录及配置详情。 应用部署记录查看：您可查看应用的最近92天的部署记录。 应用配置详情查看：您可查看应用的最新配置信息。 应用操作记录查看：您可查看应用最近一年的操作记录。 同一个应用每部署一次，增加一次版本记录，编号最新的为最近一次部署记录。您可以查看已部署的应用中的“部署日志"、“执行参数”、“访问方式”、“环境”等信息。 单击目标应用名称，进入该应用“部署记录”页面。 在“部署记录”即可查看该应用的历史版本，排序由上至下分别对应部署时间由近至远。 可在上图中单击选中某一个应用版本，可查看该应用版本的“部署日志”、“执行参数”、“访问方式”、“环境”等信息。 表1 参数说明 参数 说明 部署日志 部署日志信息。 说明： 界面默认展示应用的全量日志，单击某个步骤可查看该步骤的部署日志。 单击日志窗口右上角全屏按钮，可以最大化日志窗口；单击“退出全屏”按钮，可以退出全屏。 单击“下载全量日志”，可以将日志下载到本地。 执行参数 该应用部署时的“执行参数”中参数对应的数值。 访问方式 仅应用中“部署步骤”包含“URL健康测试”时有该参数，添加该部署步骤可以在主机上通过访问 URL 测试服务状态。 环境 在主机部署场景下，显示该应用部署的环境。 回退到“部署记录”页签，切换顶部的页签，您可以查看已部署的应用中最新的“基本信息"、“部署步骤”、“参数设置”、“部署记录”“环境管理”、“权限管理”、“通知订阅”等信息。 单击“部署”旁的图标，在下拉框中单击“操作历史”，可以查看该应用最近一年的操作记录，也可以回到应用列表，选择目标应用，单击图标，单击“操作历史”进入页面。 参数 说明 操作人 显示具体操作人员的昵称。 操作类型 显示操作人员的操作类型，分为“新建”、“修改”、“禁用”、“取消禁用”。 修改时间 显示操作的具体时间。 操作对象 显示操作人员操作的具体对象，分为“应用”、“部署步骤”、“参数设置”、“权限管理”、“通知订阅”。

安装Tomcat 添加该步骤可以在主机上安装Tomcat，信息配置如下所示。 表1 安装Tomcat参数说明 参数项 是否必填 说明 步骤显示名称 是 步骤添加后在部署步骤显示的名称。 仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 是 选择当前资源类型为主机集群的环境，作为部署对象。 tomcat版本 是 选择要安装的tomcat的版本号。 安装路径 是 tomcat的安装路径。 http端口 是 默认为8080。 ajp端口 是 默认为8009。 shutdown端口 是 默认为8005。 控制选项 否 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用的软件安装类部署步骤

参数使用 下面以具体示例演示介绍如何使用自定义参数。 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。 单击“参数设置”，切换到“参数设置”页面，分别创建环境、枚举、字符串三种类型的自定义参数并打开“运行时设置”。 单击“部署步骤”，切换到“部署步骤”页面，在步骤详情中引用自定义参数。 参数引用形式：${参数名}，在参数输入框输入“$”符号后会自动出现已创建的参数列表，根据需要选择对应参数。 例如，配置“选择软件包”项时，可以输入“$”符号带出已配置好的“package_url”参数，并选择该参数。 单击“保存并部署”，在弹窗中可重新对参数进行赋值。 单击“确定”，保存并部署该应用。 在流水线关联应用的时候，可将参数动态绑定； 在运行流水线的时候，输入的参数值会替换到应用中并运行； 在流水线中添加一个类型为部署的任务步骤，选择已配置运行时设置参数的应用，运行流水线时可动态设置。