华为云用户手册

响应示例 状态码： 200 OK 请求响应成功 { "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_connection_test" : true }, "group_id" : "ab7647b0863c4e969c8949d38d591339", "host_name" : "100.101.28.215", "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-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边账号", "host_id" : "300d6d2e53624d0da08b182099ad10f7"}

请求示例 更新应用 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" : [ ] } ]}

响应参数 状态码： 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"}

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 环境名称 description 否 String 环境描述信息

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

响应示例 状态码： 200 OK { "status" : "success", "result" : { "region" : "region", "id" : null, "name" : null, "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" : null, "update_time" : null, "role_type" : "environment-creator" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 result DevUcEnvironmentPermission object 更新后的环境权限信息 表5 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 修改时间

请求示例 https://{endpoint}/v2/applications/8ddf0566c1784da29faac80516fa8425/environments/54e5b8b0d10148cc96142ac9d6c1c1f6/permissions{ "permission_name" : "can_deploy", "permission_value" : true, "role_id" : "e72b8cebe2c6499db2b23276b3820736"}

响应示例 状态码： 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参数 参数 参数类型 描述 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 是否有复制主机权限

请求示例 新建主机时需填写主机基本信息，信息包含主机名称、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表示使用密钥认证

请求参数 表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 是 DeploymentHostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 install_icagent 否 Boolean 免费启用应用运维服务（AOM），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机） 表4 DeploymentHostAuthorizationBody 参数 是否必选 参数类型 描述 username 是 String 用户名，可输入中英文，数字和符号(-_.)。 password 否 String 密码，认证类型为0时，密码必填。 private_key 否 String 密钥，认证类型为1时，密钥必填 trusted_type 是 Integer 认证类型，0表示使用密码认证，1表示使用密钥认证

请求示例 新建主机时需填写主机基本信息，信息包含主机名称、IP地址、端口、用户名、密码等。 https://{endpoint}/v2/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}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 total Integer 应用下环境总数 result Array of EnvironmentDetail objects 环境列表信息 表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 参数解释： 用户信息，包含用户id、用户名等。 约束限制： 不涉及。 permission EnvironmentPermissionDetail object 环境权限详情 表6 UserInfo 参数 参数类型 描述 user_id String 参数解释： 用户id。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 user_name String 参数解释： 用户名。 取值范围： 只能由英文字母、数字组成，且长度为[1-255]个字符。 表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 } } ]}

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 total Integer 总数量 result Array of EnvironmentHostInfo objects 环境下主机信息列表 表5 EnvironmentHostInfo 参数 参数类型 描述 host_id String 主机id ip String 主机ip，如：161.17.101.12 port Integer ssh端口，如：22 permission EnvironmentHostPermission object 环境权限详情 group_id String 主机集群id host_name String 主机名 as_proxy Boolean 是否为代理机 proxy_host_id String 代理机id proxy_host_name String 代理机名称 owner_id String 主机所属人id owner_name String 主机所属人名称 connection_status String 连通性状态 lastest_connection_time String 上次连通时间 connection_result String 连通性验证结果 nick_name String 创建人昵称 表6 EnvironmentHostPermission 参数 参数类型 描述 can_delete Boolean 是否有删除权限 can_deploy Boolean 是否有部署权限 can_edit Boolean 是否有编辑权限 can_manage Boolean 是否有权限管理权限 can_view Boolean 是否有查看权限

URI GET /v1/applications/{application_id}/environments/{environment_id}/hosts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id environment_id 是 String 环境id 表2 Query参数 参数 是否必选 参数类型 描述 key_field 否 String 主机名、ip关键字模糊搜索 as_proxy 否 Boolean 是否为代理机,true为代理机 page_index 否 Integer 分页页码 page_size 否 Integer 分页查询每页条数

响应示例 状态码： 200 OK 请求响应成功 { "status" : "success", "result" : [ { "ip" : "100.85.172.31", "port" : 22, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_deploy" : true, "can_manage" : true }, "host_id" : "13c208e61c9541ab9895f450fd1cbf7c", "host_name" : "test", "as_proxy" : false, "group_id" : "2a8c2da888c04a5eaff10d0787c90ea4", "proxy_host_id" : "", "proxy_host_name" : null, "owner_id" : "6baa7454109d47c192f22078fe6cda20", "owner_name" : "devcloud_devcloud_l00490255_01", "nick_name" : "devcloud_devcloud_l00490255_01", "connection_status" : "failed", "connection_result" : "连接失败", "lastest_connection_time" : "2024-05-31 14:47:52" } ], "total" : 1}

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

响应参数 状态码： 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 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of DevUcClusterPermission objects 主机集群权限矩阵 表4 DevUcClusterPermission 参数 参数类型 描述 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 项目创建者

响应示例 状态码： 200 OK 请求响应成功 [ { "region" : "region", "name" : "Host cluster creator", "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" : "2024-05-31 14:32:59.0", "update_time" : "2024-05-31 14:32:59.0", "role_type" : "cluster-creator"}, { "region" : "region", "name" : "Project admin", "role_id" : "a2e65d2647574f8491cac659a0249d24", "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" : "2024-05-31 14:32:59.0", "update_time" : "2024-05-31 14:32:59.0", "role_type" : "project"} ]

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

请求示例 查询应用项目级权限矩阵 https://{endpoint}/v3/applications/permissions?project_id=0a38ce9ba3c740c199a0f872b6163661 查询应用实例级权限矩阵 https://{endpoint}/v3/applications/permissions?app_id=0a38ce9ba3c740c199a0f872b6163661

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Array of ApplicationPermissionVO objects 角色应用权限 status String 请求成功失败状态 表4 ApplicationPermissionVO 参数 参数类型 描述 can_modify Boolean 是否有编辑权限 can_delete Boolean 是否有删除的权限 can_view Boolean 是否有查看权限 can_execute Boolean 是否有执行权限 can_copy Boolean 是否有复制权限 can_manage Boolean 是否有管理权限，包含增删改查执行以及权限修改 can_create_env Boolean 是否有新建环境权限 can_disable Boolean 是否有禁用权限 name String 角色名称 region String 局点信息 role_id String 角色id role_type String 角色类型， app-creator： 应用创建者； project： 项目管理员；template-customized-inst：系统角色； template-project-customized、project-customized：自定义角色

响应示例 状态码： 200 OK 请求响应成功 { "result" : [ { "can_copy" : true, "can_create_env" : true, "can_delete" : true, "can_disable" : true, "can_execute" : true, "can_manage" : true, "can_modify" : true, "can_view" : true, "name" : "应用创建者", "region" : "cn-north-7", "role_id" : "0", "role_type" : "app-creator" }, { "can_copy" : true, "can_create_env" : true, "can_delete" : true, "can_disable" : true, "can_execute" : true, "can_manage" : true, "can_modify" : true, "can_view" : true, "name" : "项目管理员", "region" : "cn-north-7", "role_id" : "2e510051361942a8b7ecea00144172b3", "role_type" : "project" } ], "status" : "success"}