华为云用户手册

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json;charset=utf-8 枚举值： application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：20000 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 主机集群名 最小长度：3 最大长度：128 region_name 是 String 局点信息 最小长度：1 最大长度：20 project_id 是 String 项目ID，获取方式请参见获取项目ID。 os 是 String 操作系统：windows|linux 枚举值： windows linux slave_cluster_id 否 String slave集群id，默认为null时使用默认slave集群，用户自定义slave时为slave集群id description 否 String 描述 最小长度：0 最大长度：500 is_proxy_mode 否 Integer 主机集群是否为代理机接入模式， 1：是 0：否 枚举值： 0 1

请求示例 新建主机集群时需填写基本信息，信息包含主机集群名称、描述、操作系统、是否为代理机接入模式等。 https://{endpoint}/v2/host-groups { "name" : "test123", "description" : "", "region_name" : "cn-north-7", "project_id" : "6039d4480efc4dddb178abff98719913", "os" : "linux", "slave_cluster_id" : "", "is_proxy_mode" : 1 }

响应示例 状态码： 200 OK 请求响应成功 { "task_id" : "d2dc947ec2424d8789bb3984bb3adf45", "name" : "wyktest111", "state" : "Available", "description" : "111222", "owner" : "devcloud_devcloud_l00490255_01", "steps" : { "step1" : { "id" : "1583", "name" : "选择部署来源", "params" : { }, "enable" : true }, "step2" : { "id" : "1293", "name" : "URL健康测试", "params" : { }, "enable" : true } }, "project_id" : "6039d4480efc4dddb178abff98719913", "project_name" : "wyk_test", "deploy_system" : "deployTemplate", "create_time" : "2021-04-01 17:07:49", "update_time" : "2021-05-17 11:26:58", "role_id" : 0, "is_defaut_permission" : false, "template_id" : "242ea879b3444b8391c3feb2e9c073de", "nick_name" : "AB边账号", "owner_id" : "6baa7454109d47c192f22078fe6cda20", "tenant_id" : "26a680dd72e7482eb60d2ef5513588bb", "tenant_name" : "devcloud_devcloud_l00490255_01", "slave_cluster_id" : "", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : true, "can_disable" : false, "app_component_list" : [ ], "is_disable" : true }

查询主机集群列表 接口信息： URI：GET /v2/host-groups API Explorer 在线调试请参见：查询主机集群列表。 请求示例： GET https://{endpoint}/v2/host-groups?region_name=cn-north-7&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=create_time&sort_dir=DESC 响应示例： { "total" : 1, "host_groups" : [ { "name" : "testwyk", "description" : "11122211", "os" : "linux", "nick_name" : "AB边账号", "id" : 200001291, "group_id" : "ab7647b0863c4e969c8949d38d591339", "region_name" : "cn-north-7", "project_id" : "6039d4480efc4dddb178abff98719913", "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_manage" : true }, "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "updated_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "auto_connection_test_switch" : 0, "slave_cluster_id" : "", "created_time" : "2021-04-01 17:05:53", "updated_time" : "2021-04-21 14:29:14", "host_count" : 1, "project_name" : null } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json;charset=utf-8 枚举值： application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：20000 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 主机集群名 最小长度：3 最大长度：128 project_id 是 String 项目ID，获取方式请参见获取项目ID。 os 是 String 操作系统：windows|linux 枚举值： windows linux slave_cluster_id 否 String slave集群id，默认为null时使用默认slave集群，用户自定义slave时为slave集群id description 否 String 描述 最小长度：0 最大长度：500 is_proxy_mode 是 Integer 主机集群是否为代理机接入模式， 1：是 0：否 枚举值： 0 1

请求示例 新建主机集群时需填写基本信息，信息包含主机集群名称、描述、操作系统、是否为代理机接入模式等。 https://{endpoint}/v1/resources/host-groups { "name" : "test123", "description" : "", "project_id" : "6039d4480efc4dddb178abff98719913", "os" : "linux", "slave_cluster_id" : "", "is_proxy_mode" : 1 }

响应示例 状态码： 200 OK 请求响应成功 { "status" : "success", "result" : { "id" : "ab7647b0863c4e969c8949d38d591339", "name" : "test", "description" : "11122211", "os" : "linux", "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_manage" : true }, "is_proxy_mode" : 0, "slave_cluster_id" : "", "nick_name" : "AB边账号", "created_time" : "2021-04-01 17:05:53", "updated_time" : "2021-04-21 14:29:14" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态 最小值：0 最大值：1000 result HostClusterInfoDetailDetail object 主机集群信息 表4 HostClusterInfoDetailDetail 参数 参数类型 描述 id String 主机集群id 最小长度：32 最大长度：32 name String 主机集群名 os String 操作系统：windows|linux slave_cluster_id String slave集群id，默认为null时使用默认slave集群，用户自定义slave时为slave集群id created_by UserInfo object 用户信息 description String 描述 最小长度：0 最大长度：500 permission PermissionClusterDetail object 主机集群相关权限详情类 nick_name String 创建人名称 is_proxy_mode Integer 是否是代理模式 created_time String 创建时间 updated_time String 更新时间 表5 UserInfo 参数 参数类型 描述 user_id String 用户id user_name String 用户名 表6 PermissionClusterDetail 参数 参数类型 描述 can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_manage Boolean 是否有编辑主机集群权限矩阵的权限

概述 欢迎使用部署服务（CodeArts Deploy）。部署服务提供可视化、一键式部署服务，支持部署到虚拟机或者容器，提供Tomcat、SpringBoot等模板或者自由组装编排原子步骤进行部署，支持并行部署和流水线无缝集成，实现部署环境标准化和部署过程自动化。您可以使用本文档提供的API对部署服务进行相关操作，如新建主机、新建主机集群、部署应用等。支持的全部操作请参见API概览。 在调用部署服务的API之前，请确保已经充分了解部署服务的相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

请求示例 https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments/666ec038a53c4b9f899823747a7130e8/hosts/import { "group_id" : "4b0cb2f098174d38b0c15645c13eae6f", "host_ids" : [ "8e1eb7f010d4442ca150e3a1a5d96d94" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json;charset=utf-8 枚举值： application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 String 主机集群id host_ids 是 Array of strings 要导入的主机ids 最小长度：32 最大长度：32

响应示例 状态码： 200 OK 请求响应成功 { "id" : "0ee9c8e6a7dc44109541e53c6dccf47c", "task_id" : "d2dc947ec2424d8789bb3984bb3adf45", "job_name" : "job_0ee9c8e6a7dc44109541e53c6dccf47c_1620810492008", "app_component_list" : [ ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json;charset=utf-8 枚举值： application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 Array of DynamicConfigInfo objects 部署应用时传递的参数 数组长度：0 - 500 record_id 否 String 应用的部署id，可通过record_id回滚至之前的部署状态。选中应用历史部署记录，在URL中获取 trigger_source 否 String 限制触发来源,0不限制任何部署请求来源,1时只允许通过流水线触发部署 表4 DynamicConfigInfo 参数 是否必选 参数类型 描述 key 否 String 部署应用时传递的参数名称 最小长度：1 最大长度：128 value 否 String 部署应用时传递的参数值 最小长度：1 最大长度：8192 type 否 String 类型，如果填写动态参数，则类型必选 枚举值： text host_group encrypt enum

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 id String 部署记录id task_id String 部署任务id job_name String 执行任务名称 最小长度：45 最大长度：55 app_component_list Array of AppComponentDao objects 应用和 AOM 应用组件对应关系 表6 AppComponentDao 参数 参数类型 描述 task_id String 部署任务id app_id String AOM应用id app_name String AOM应用名称 comp_id String AOM应用组件id comp_name String AOM应用组件名称 最小长度：0 最大长度：128 domain_id String 租户ID region String 局点信息 最小长度：1 最大长度：256 state String AOM应用组件是否生效，0表示初始化，1表示执行成功，已生效 最小长度：1 最大长度：32

URI GET /v1/applications/{application_id}/environments 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 最小长度：32 最大长度：32 page_index 否 Integer 分页页码，表示从此页开始查询，page大于等于1 最小值：1 最大值：50 缺省值：1 page_size 否 Integer 每页显示的条目数量，size小于等于100 最小值：1 最大值：100 缺省值：100 name 否 String 要查询的环境名称 最大值：128 sort_key 否 String 排序字段，支持按照环境名称|用户名称|创建时间|用户昵称排序 缺省值：CREATED_TIME 枚举值： NAME USER_NAME CREATED_TIME NICK_NAME sort_dir 否 String 排序顺序，DESC降序，ASC升序 缺省值：DESC 枚举值： DESC ASC

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String 响应状态 total Integer 应用下环境总数 result Array of EnvironmentDetail objects 环境列表信息 数组长度：0 - 100 表5 EnvironmentDetail 参数 参数类型 描述 id String 环境id name String 环境名称 description String 环境描述 os String 操作系统 nick_name String 用户昵称 deploy_type Integer 部署类型：0表示主机, 1表示kubernetes created_time String 创建时间 instance_count Integer 环境下主机实例数量 created_by UserInfo object 用户信息 permission EnvironmentPermissionDetail object 环境权限详情 表6 UserInfo 参数 参数类型 描述 user_id String 用户id user_name String 用户名 表7 EnvironmentPermissionDetail 参数 参数类型 描述 can_delete Boolean 是否有删除环境权限 can_deploy Boolean 是否有部署权限 can_edit Boolean 是否有编辑环境权限 can_manage Boolean 是否有编辑环境权限矩阵的权限 can_view Boolean 是否有环境的查看权限

响应示例 状态码： 200 OK 请求响应成功 { "status" : "success", "total" : 1, "result" : [ { "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "created_time" : "2023-06-20 16:53:29.0", "deploy_type" : 0, "description" : "", "id" : "a0a2274acc4f482bb2ecf49f865879fa", "name" : "casdasd", "nick_name" : "AB边账号", "os" : "linux", "permission" : { "can_delete" : true, "can_deploy" : true, "can_edit" : true, "can_manage" : true, "can_view" : true } } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 响应状态 result EnvironmentDetail object 环境详情 表4 EnvironmentDetail 参数 参数类型 描述 id String 环境id name String 环境名称 description String 环境描述 os String 操作系统 nick_name String 用户昵称 deploy_type Integer 部署类型：0表示主机, 1表示kubernetes created_time String 创建时间 instance_count Integer 环境下主机实例数量 created_by UserInfo object 用户信息 permission EnvironmentPermissionDetail object 环境权限详情 表5 UserInfo 参数 参数类型 描述 user_id String 用户id user_name String 用户名 表6 EnvironmentPermissionDetail 参数 参数类型 描述 can_delete Boolean 是否有删除环境权限 can_deploy Boolean 是否有部署权限 can_edit Boolean 是否有编辑环境权限 can_manage Boolean 是否有编辑环境权限矩阵的权限 can_view Boolean 是否有环境的查看权限

响应示例 状态码： 200 OK 请求响应成功 { "status" : "success", "result" : { "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "created_time" : "2023-06-20 16:53:29.0", "deploy_type" : 0, "description" : "", "id" : "a0a2274acc4f482bb2ecf49f865879fa", "name" : "casdasd", "nick_name" : "AB边账号", "os" : "linux", "permission" : { "can_delete" : true, "can_deploy" : true, "can_edit" : true, "can_manage" : true, "can_view" : true } } }

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参加AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应示例 状态码： 200 OK 请求响应成功 { "hosts" : [ { "host_name" : "100.101.28.203", "ip" : "100.101.28.203", "port" : 22, "os" : "linux", "authorization" : { "username" : "root", "password" : null, "private_key" : null, "trusted_type" : 0 }, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_connection_test" : true }, "host_id" : "2cc913cc9a494f09b7320801ebacad02", "group_id" : "ab7647b0863c4e969c8949d38d591339", "as_proxy" : false, "proxy_host_id" : null, "owner_id" : "6baa7454109d47c192f22078fe6cda20", "owner_name" : "devcloud_devcloud_l00490255_01", "updator_id" : "6baa7454109d47c192f22078fe6cda20", "updator_name" : "devcloud_devcloud_l00490255_01", "connection_status" : "success", "install_icagent" : false, "create_time" : "2021-04-15 11:01:51", "update_time" : "2021-04-21 15:04:24", "connection_result" : "连接成功", "lastest_connection_time" : "2021-04-15 11:02:00", "nick_name" : "AB边账号", "proxy_host" : null, "group_name" : null, "project_id" : "6039d4480efc4dddb178abff98719913", "project_name" : null } ], "total" : 1, "group_name" : "test" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 主机数量 最小值：0 最大值：200 group_name String 主机集群名称 最小长度：3 最大长度：128 hosts Array of DeploymentHostDetail objects 主机列表信息 数组长度：0 - 200 表5 DeploymentHostDetail 参数 参数类型 描述 group_id String 主机集群id 最小长度：32 最大长度：32 host_name String 主机名称 最小长度：3 最大长度：128 ip String IP，请输入弹性ip格式：161.17.101.12 port Integer ssh端口，如：22 os String 操作系统：windows|linux，需要和主机集群保持一致 枚举值： windows linux as_proxy Boolean 是否为代理机 proxy_host_id String 代理机id authorization DeploymentHostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 install_icagent Boolean 免费启用应用运维服务（AOM），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机） host_id String 主机ID proxy_host DeploymentHostDetail object 代理机信息详情 group_name String 主机集群名 最小长度：3 最大长度：128 project_id String 项目ID，获取方式请参见获取项目ID。 project_name String 项目名称 最小长度：3 最大长度：128 permission PermissionHostDetail object 主机相关权限详情类 update_time String 更新时间 lastest_connection_time String 最后连接时间 connection_status String 连接状态 owner_name String 拥有者名称 updator_id String 维护者id create_time String 创建时间 nick_name String 昵称 owner_id String 拥有者id updator_name String 维护者名称 connection_result String 连接结果 表6 DeploymentHostAuthorizationBody 参数 参数类型 描述 username String 用户名，可输入中英文，数字和符号(-_.)。 最小长度：3 最大长度：128 password String 密码，认证类型为0时，密码必填。 private_key String 密钥，认证类型为1时，密钥必填 最小长度：1 最大长度：5000 trusted_type Integer 认证类型，0表示使用密码认证，1表示使用密钥认证 枚举值： 0 1 表7 PermissionHostDetail 参数 参数类型 描述 can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_connection_test Boolean 是否有测试主机连通性权限

URI GET /v2/host-groups/{group_id}/hosts 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 主机集群id 表2 Query参数 参数 是否必选 参数类型 描述 as_proxy 否 Boolean 是否为代理机 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0 最小值：0 limit 否 Integer 每页显示的条目数量，默认为1000 最小值：1 最大值：1000 name 否 String 主机名，可输入中英文，数字和符号(-_.) 最小长度：3 最大长度：128 sort_key 否 String 排序字段，支持：AS_PROXY|HOST_NAME|OS|OWNER_NAME|as_proxy|host_name|os|owner_name|nickName。不填默认为：as_proxy sort_dir 否 String 排序方式,默认为：DESC。DESC：降序排序。ASC：升序排序 枚举值： DESC ASC with_auth 否 Boolean 返回结果是否加密

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json;charset=utf-8 枚举值： application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 主机集群名 最小长度：3 最大长度：128 description 否 String 描述 最小长度：0 最大长度：500 slave_cluster_id 否 String 自定义slave资源池id auto_connection_test_switch 否 Integer 自动测试功能已下架，该字段已失效 枚举值： 0 1 2

请求示例 修改目标主机集群基本信息，信息包含主机集群名称、描述等。 https://{endpoint}/v2/host-groups/f3938bd63e354d2bb9d9cf7b5dc3bf95 { "name" : "test123", "description" : "这是一条描述信息", "slave_cluster_id" : "", "auto_connection_test_switch" : 0 }

操作步骤 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。 单击“基本信息”，切换到“基本信息”页面，可根据需要对应用名称、描述、执行主机等信息进行修改。 表1 参数说明 参数项 说明 应用名称 必填。应用的名称。 所属项目 默认。该应用的归属项目。如果账号下没有项目请您在项目选择框中选择“新建项目”会先弹出“新建项目”页面，这时建立的项目是Scrum。 描述 可选。对应用的描述。 执行主机 可选。资源池是部署软件包时执行部署命令的物理环境的集合，您可以使用华为云托管的官方资源池，您也可以将自有的服务器作为自托管资源池托管到华为云，托管方式请参考自托管资源池场景。 来自流水线 可选。开启后，只能通过流水线驱动执行，不能单独执行。 注意：如果租户账号已配置“全内网安全访问”功能（仅限白名单用户使用），则“执行主机”功能默认选择“自托管资源池”且不可更改。 修改完所有信息，单击“保存”，保存该应用。

操作步骤 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。 单击“通知订阅”，即可切换到“通知订阅”页面。 设置应用相关事件的通知，请根据实际情况单击（表示开启）/（表示关闭）进行设置。 邮件动态：提供应用动态邮件推送能力，以发送邮件的形式，向应用创建者、执行者和已关注该应用的成员发送应用动态。 钉钉：提供应用动态钉钉推送能力，填写webhook地址，勾选可触发 消息通知 的应用运行状态，配置通知内容即可。 启用加签秘钥：钉钉自定义机器人必须开启安全设置，若未使用加签，无需填写加签秘钥。 企业微信：提供应用动态企业微信推送能力，填写webhook地址，勾选可触发消息通知的应用运行状态，配置通知内容即可。 修改完所有信息，单击“保存”，保存该应用。