华为云用户手册

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 total Integer 关联环境总数量 result Array of EnvironmentInfo objects 环境信息列表 表5 EnvironmentInfo 参数 参数类型 描述 id String 环境id name String 环境名称 app_id String 应用id app_name String 应用名称 project_id String 项目id

响应示例 状态码：200 OK 请求响应成功 { "status" : "success", "result" : [ { "id" : "54e5b8b0d10148cc96142ac9d6c1c1f6", "name" : "更新测试环境", "project_id" : "7e6caf3cd9a64d5b8ea451e38221892e", "app_name" : "虚机部署更新", "app_id" : "8ddf0566c1784da29faac80516fa8425" } ], "total" : 1 }

请求示例 修改目标主机基本信息，信息包含主机名称、IP地址、端口等。 https://{endpoint}/v2/host-groups/ab7647b0863c4e969c8949d38d591339/hosts/300d6d2e53624d0da08b182099ad10f7 { "host_name" : "100.101.28.215", "ip" : "100.101.28.215", "port" : 22, "as_proxy" : false, "proxy_host_id" : null, "authorization" : { "username" : "root", "password" : null, "private_key" : "", "trusted_type" : 0 }, "install_icagent" : false, "sync" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 host_name 是 String 主机名称 ip 是 String IPv4/IPv6格式的IP地址 port 是 Integer ssh端口，如：22 as_proxy 是 Boolean 是否为代理机 proxy_host_id 否 String 代理机id authorization 是 DeploymentHostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 install_icagent 否 Boolean 免费启用应用运维服务（ AOM ），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机） sync 否 Boolean 是否将当前主机的密码信息同步到同一项目下其他主机集群中具有相同IP、用户名、端口的主机。 表4 DeploymentHostAuthorizationBody 参数 是否必选 参数类型 描述 username 是 String 用户名，可输入中英文，数字和符号(-_.)。 password 否 String 密码，认证类型为0时，密码必填。 private_key 否 String 密钥，认证类型为1时，密钥必填 trusted_type 是 Integer 认证类型，0表示使用密码认证，1表示使用密钥认证

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 host_uuids 是 Array of strings 主机id列表 target_group_id 是 String 目标主机集群id

请求示例 https://{endpoint}/v1/resources/host-groups/8518ee4e95924495ae18addce39b2015/hosts/replication { "host_uuids" : [ "5fd1c0334d7343338054af811fef8e4b" ], "target_group_id" : "849f425a74034fd2a4e60c367414efba" }

请求示例 新建主机时需填写主机基本信息，信息包含主机名称、IP地址、端口、用户名、密码等。 https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339/hosts { "host_name" : "100.101.28.215", "ip" : "100.101.28.215", "port" : "22", "os" : "linux", "as_proxy" : false, "proxy_host_id" : "", "authorization" : { "username" : "root", "password" : "*****", "private_key" : "", "trusted_type" : 0 }, "install_icagent" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 host_name 是 String 主机名称 ip 是 String IPv4/IPv6格式的IP地址 port 是 Integer ssh端口，如：22 os 是 String 操作系统：windows|linux，需要和主机集群保持一致 as_proxy 是 Boolean 是否为代理机 proxy_host_id 否 String 代理机id authorization 是 HostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 install_icagent 否 Boolean 免费启用应用运维服务（AOM），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机） 表4 HostAuthorizationBody 参数 是否必选 参数类型 描述 username 是 String 用户名，可输入中英文，数字和符号(-_.)。 password 否 String 密码，认证类型为0时，密码必填。 private_key 否 String 密钥，认证类型为1时，密钥必填 trusted_type 是 Integer 认证类型，0表示使用密码认证，1表示使用密钥认证

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 result Array of AppGroupsEntity objects 分组信息列表 status String 请求成功失败状态 表4 AppGroupsEntity 参数 参数类型 描述 id String 分组id name String 分组名称 project_id String 项目id path String 分组路径 parent_id String 父分组id，首层为null ordinal Integer 分组排序字段 create_user_id String 分组创建者用户id last_update_user_id String 最近一次更新该分组用户id count Integer 该分组应用总数 children Array of AppGroupsEntity objects 子分组列表

响应示例 状态码：200 OK 请求响应成功 { "result" : [ { "project_id" : "0a38ce9ba3c740c199a0f872b6163661", "path" : "55ad749142fc405398aad372a1f9eff1", "parent_id" : null, "ordinal" : 1, "name" : "group_1", "last_update_user_id" : "057842a25b000f6b1fcbc014a9cccccc", "id" : "55ad749142fc405398aad372a1f9eff1", "create_user_id" : "057842a25b000f6b1fcbc014a9cccccc", "count" : 0, "children" : [ ] } ], "status" : "success" }

响应示例 状态码：200 OK 请求响应成功 { "result" : [ { "duration" : "00:16:53", "state" : "succeeded", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "50f18ce454a64ea5a62a33d56617b831", "start_time" : "2022-04-15 15:03:24", "nickname" : "AB边账号", "end_time" : "2022-04-15 15:20:17", "release_id" : 20 }, { "duration" : "00:15:31", "state" : "failed", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "f757fbe93d35494ba0ff73b34e2f79aa", "start_time" : "2022-04-15 15:03:15", "nickname" : "AB边账号", "end_time" : "2022-04-15 15:18:46", "release_id" : 19 } ], "total_num" : 20 }

URI GET /v2/{project_id}/task/{id}/history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目id，获取方式请参见获取项目id。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 id 是 String 参数解释： 部署任务id。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page 是 Integer 参数解释： 分页页码， 表示从此页开始查询。 约束限制： 不涉及。 取值范围： 1-99999 默认取值： 不涉及。 size 是 Integer 参数解释： 每页显示的条目数量。 约束限制： 不涉及。 取值范围： 1-100 默认取值： 不涉及。 start_date 是 String 参数解释： 区间开始时间。格式为yyyy-MM-dd。例如：2022-03-16。 约束限制： 与end_date配合使用，end_date需大于等于start_date，开始时间和结束时间间隔不能超过30天。 取值范围： 不涉及。 默认取值： 不涉及。 end_date 是 String 参数解释： 区间结束时间。格式为yyyy-MM-dd。例如：2022-04-15。 约束限制： 与start_date配合使用，end_date需大于等于start_date，开始时间和结束时间间隔不能超过30天。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 result Array of ExecuteRecordV2Body objects 参数解释： 应用历史部署记录列表。 total_num Integer 参数解释： 开始时间和结束时间内应用历史部署记录总数。 取值范围： 不涉及。 表5 ExecuteRecordV2Body 参数 参数类型 描述 duration String 参数解释： 部署用时。 取值范围： 不涉及。 state String 参数解释： 应用状态。 取值范围： 不涉及。 operator String 参数解释： 操作人用户名。 取值范围： 不涉及。 execution_id String 参数解释： 部署记录id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 start_time String 参数解释： 部署应用的开始时间。格式为yyyy-MM-dd HH:mm:ss。例如：2021-02-25 10:37:27。 取值范围： 不涉及。 nickname String 参数解释： 操作人昵称。 取值范围： 不涉及。 end_time String 参数解释： 部署应用的结束时间。格式为yyyy-MM-dd HH:mm:ss。例如：2021-02-25 10:37:27。 取值范围： 不涉及。 release_id Long 参数解释： 部署记录序列号。 取值范围： 不涉及。 type String 参数解释： 部署类型。 取值范围： install: 安装部署

响应示例 状态码：200 权限数据，list类型数据 [ { "region" : "region", "id" : 99213234, "name" : "环境创建者", "role_id" : "0", "devuc_role_id_list" : null, "environment_id" : "be3e9690d6f64b23b54e79cd02c4b156", "can_view" : true, "can_edit" : true, "can_delete" : true, "can_deploy" : true, "can_manage" : true, "create_time" : "2024-06-21 17:23:55.0", "update_time" : "2024-06-21 17:23:55.0", "role_type" : "environment-creator" }, { "region" : "region", "id" : 99213235, "name" : "项目管理员", "role_id" : "a2e65d2647574f8491cac659a0249d24", "devuc_role_id_list" : null, "environment_id" : "be3e9690d6f64b23b54e79cd02c4b156", "can_view" : true, "can_edit" : true, "can_delete" : true, "can_deploy" : true, "can_manage" : true, "create_time" : "2024-06-21 17:23:55.0", "update_time" : "2024-06-21 17:23:55.0", "role_type" : "project" } ]

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of DevUcEnvironmentPermission objects 权限数据，list类型数据 表4 DevUcEnvironmentPermission 参数 参数类型 描述 id Integer 权限id role_id String 角色id devuc_role_id_list Array of strings 角色id列表 role_type String 角色类型， environment-creator： 环境创建者； project： 项目管理员；template-customized-inst：系统角色； template-project-customized、project-customized：自定义角色 name String 角色名称 region String 局点信息 environment_id String 环境id can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_deploy Boolean 是否有部署权限 can_manage Boolean 是否有权限管理权限 create_time String 创建时间 update_time String 修改时间

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 result HostInfoDetail object 主机详情信息 表4 HostInfoDetail 参数 参数类型 描述 host_id String 主机id ip String 主机IP os String 主机操作系统 port Integer 端口号 authorization HostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 permission PermissionHostDetailNew object 主机相关权限详情类 group_id String 主机集群id host_name String 主机名 as_proxy Boolean 是否为代理机 proxy_host_id String 代理机id owner_name String 主机所属人名称 proxy_host HostInfoDetail object 代理机信息详情 connection_status String 连通性状态 create_time String 创建时间 update_time String 更新时间 lastest_connection_time String 上次连通时间 connection_result String 连通性验证结果 install_icagent Boolean 免费启用应用运维服务（AOM），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机） nick_name String 创建人昵称 表5 HostAuthorizationBody 参数 参数类型 描述 username String 用户名，可输入中英文，数字和符号(-_.)。 password String 密码，认证类型为0时，密码必填。 private_key String 密钥，认证类型为1时，密钥必填 trusted_type Integer 认证类型，0表示使用密码认证，1表示使用密钥认证 表6 PermissionHostDetailNew 参数 参数类型 描述 can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_copy Boolean 是否有复制主机权限

响应示例 状态码：200 OK 请求响应成功 { "result" : { "host_id" : "300d6d2e53624d0da08b182099ad10f7", "ip" : "100.101.28.215", "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_copy" : true }, "group_id" : "ab7647b0863c4e969c8949d38d591339", "host_name" : "100.101.28.215", "as_proxy" : false, "proxy_host_id" : null, "owner_name" : "devcloud_devcloud_l00490255_01", "proxy_host" : null, "connection_status" : "success", "install_icagent" : false, "create_time" : "2021-05-13 09:35:41", "update_time" : "2021-05-13 09:35:41", "connection_result" : "连接成功", "lastest_connection_time" : "2021-05-13 09:36:11", "nick_name" : "AB边账号" }, "status" : "success" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 group_id String 主机集群id created_time String 创建时间 updated_time String 修改时间 host_count Integer 集群内主机数量，一个主机集群内最多可添加200台主机 project_name String 项目名称 name String 主机集群名 region_name String 局点信息 project_id String 项目id，获取方式请参见获取项目id。 os String 操作系统：windows|linux auto_connection_test_switch Integer 自动测试功能已下架，该字段已失效 slave_cluster_id String slave集群id，默认为null时使用默认slave集群，用户自定义slave时为slave集群id nick_name String 用户昵称 created_by UserInfo object 参数解释： 用户信息，包含用户id、用户名等。 约束限制： 不涉及。 updated_by UserInfo object 参数解释： 用户信息，包含用户id、用户名等。 约束限制： 不涉及。 description String 描述 permission PermissionGroupDetail object 主机集群相关权限详情类 表4 UserInfo 参数 参数类型 描述 user_id String 参数解释： 用户id。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 user_name String 参数解释： 用户名。 取值范围： 只能由英文字母、数字组成，且长度为[1-255]个字符。 表5 PermissionGroupDetail 参数 参数类型 描述 can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_manage Boolean 是否有编辑主机集群权限矩阵的权限

响应示例 状态码：200 OK 请求响应成功 { "name" : "test", "description" : "11122211", "os" : "linux", "region_name" : "cn-north-7", "project_id" : "6039d4480efc4dddb178abff98719913", "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "updated_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 }, "auto_connection_test_switch" : 0, "slave_cluster_id" : "", "nick_name" : "AB边账号", "group_id" : "ab7647b0863c4e969c8949d38d591339", "created_time" : "2021-04-01 17:05:53", "updated_time" : "2021-04-21 14:29:14", "host_count" : 1 }

调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v4/projects/”，其中{Endpoint}为需求管理的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“project_id”即为项目ID。 { "projects" : [ { "project_num_id" : 3183801, "project_id" : "41bd3eab86544863b8fc92ffcd35e3c8", "project_name" : "demo_project", "description" : "demo", "created_time" : 1576114296000, "updated_time" : 1576114296000, "project_type" : "xboard", "creator" : { "user_num_id" : 4097, "user_id" : "c4bd39f0573a436589714bedbcca8536", "user_name" : "modile_user", "domain_id" : "2489d8cbba804db8bcd35384685ff3ac", "domain_name" : "modile_user", "nick_name" : "Tom.M.Riddle" } } ], "total" : 10 }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 result AppBaseResponse object 参数解释： 创建和删除应用响应体。 表7 AppBaseResponse 参数 参数类型 描述 id String 参数解释： 应用id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 name String 参数解释： 应用名称。 取值范围： 由中文字符、英文字母、数字及“_”、“-”组成，且长度为[3-128]个字符。 region String 参数解释： 应用所属区域。 取值范围： 不涉及。 arrange_infos Array of TaskBaseBody objects 参数解释： 部署任务列表。 表8 TaskBaseBody 参数 参数类型 描述 id String 参数解释： 部署任务id。 取值范围： 由英文字母、数字组成，且长度为32个字符。

响应示例 状态码：200 OK 请求响应成功 { "result" : { "id" : "e700f15965694253940502911220d76b", "name" : "testApp", "region" : "cn-north-7", "arrange_infos" : [ { "id" : "e700f15965694253940502911220d76b" } ] }, "status" : "success" }

请求示例 更新应用 https://{endpoint}/v1/applications { "id" : "e700f15965694253940502911220d76b", "name" : "deployenv20230822192953", "project_id" : "55837d272adf4eee90319800e2da6961", "description" : "更新应用", "trigger" : { "trigger_source" : 0, "artifact_source_system" : "", "artifact_type" : "" }, "slave_cluster_id" : "", "create_type" : "template", "is_draft" : true, "arrange_infos" : [ { "id" : "e700f15965694253940502911220d76b", "deploy_system" : "deployTemplate", "template_id" : "ec939bdf63194aca9fad45b3ba05643e", "operation_list" : [ ] } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 应用id project_id 是 String 项目id name 是 String 应用名称 description 否 String 描述 is_draft 是 Boolean 是否为草稿 create_type 是 String 创建类型，template：部署模板创建 slave_cluster_id 否 String 自定义slave资源池id trigger 否 TaskTriggerVO object 部署应用执行触发设置 arrange_infos 否 Array of UpdateTaskV2RequestBody objects 部署任务列表信息 表3 TaskTriggerVO 参数 是否必选 参数类型 描述 trigger_source 否 String 部署任务允许执行的场景。其中0：所有执行请求均可，1：只允许流水线触发 artifact_source_system 否 String 当任务只允许流水线触发执行时，流水线传递的来源信息，当前只有CodeArtsArtifact artifact_type 否 String 当任务只允许流水线触发执行时，对应流水线源的制品仓库类型（generic、docker） 表4 UpdateTaskV2RequestBody 参数 是否必选 参数类型 描述 id 否 String 部署任务id deploy_system 否 String 部署系统，deployTemplate：部署模板 template_id 否 String 模板id operation_list 否 Array of DeployV2OperationsDO objects 部署编排列表信息 表5 DeployV2OperationsDO 参数 是否必选 参数类型 描述 id 否 String 步骤id name 否 String 步骤名称 description 否 String 步骤描述 code 否 String 下载地址 params 否 String 步骤详细定义 entrance 否 String 入口函数 version 否 String 版本 module_id 否 String 模块id

请求示例 https://{endpoint}/v2/host-groups/2a8c2da888c04a5eaff10d0787c90ea4/permissions { "permission_name" : "can_delete", "permission_value" : true, "project_id" : "7e6caf3cd9a64d5b8ea451e38221892e", "role_id" : "c869ebc4000c4bb9a2605c4020450ab4" }

响应示例 状态码：200 OK 请求响应成功 { "region" : "region", "name" : null, "role_id" : "0", "devuc_role_id_list" : null, "group_id" : "2a8c2da888c04a5eaff10d0787c90ea4", "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_manage" : true, "can_copy" : true, "create_time" : null, "update_time" : null, "role_type" : "cluster-creator" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 region String 局点信息 role_id String 角色id devuc_role_id_list Array of strings 角色id列表 name String 角色名称 group_id String 主机集群id can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_manage Boolean 是否有权限管理权限 can_copy Boolean 是否有拷贝权限 create_time String 创建时间 update_time String 修改时间 role_type String 角色类型，project-customized：自定义角色；template-project-customized：系统自定义角色；template-customized-inst：系统角色；cluster-creator：集群创建者；project_admin 项目创建者

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id role_id 是 String 角色id permission_name 是 String 权限名称，can_view：查看权限；can_edit：编辑权限；can_delete：删除权限；can_add_host：添加主机权限；can_manage：权限管理权限；can_copy：复制主机权限 permission_value 是 Boolean true 有权限，false 无权限

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 success_rate String 参数解释： 成功率。 取值范围： 不涉及。 project_id String 参数解释： 项目id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 project_name String 参数解释： 项目名称。 取值范围： 长度为[3,128]个字符。 start_date String 参数解释： 部署应用开始时间范围的左边界（包含）。格式为yyyy-MM-dd。例如：2022-10-26。 取值范围： 不涉及。 end_date String 参数解释： 部署应用开始时间范围的右边界（包含）。格式为yyyy-MM-dd。例如：2022-10-26。 取值范围： 不涉及。 task_count Integer 参数解释： 查询到的应用数。 取值范围： 不涉及。 record_count Integer 参数解释： 查询到的应用部署记录数。 取值范围： 不涉及。 success_record_count Integer 参数解释： 成功的应用部署记录数。 取值范围： 不涉及。

响应示例 状态码：200 OK 请求响应成功 { "success_rate" : "34.09", "project_id" : "89931e210b214b5892ea833712f0f5e0", "project_name" : "Happy", "start_date" : "2022-01-01", "end_date" : "2022-10-26", "task_count" : 8, "record_count" : 44, "success_record_count" : 15 }