华为云用户手册

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

URI GET /v2/{project_id}/metrics/success-rate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目id，获取方式请参见获取项目id。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 start_date 是 String 参数解释： 部署应用开始时间范围的左边界（包含）。格式为yyyy-MM-dd。例如：2022-01-01。 约束限制： 与end_date配合使用，end_date需大于等于start_date，且最大时间范围为1年。 取值范围： 不涉及。 默认取值： 不涉及。 end_date 是 String 参数解释： 部署应用开始时间范围的右边界（包含）。格式为yyyy-MM-dd。例如：2022-10-26。 约束限制： 与start_date配合使用，end_date需大于等于start_date，且最大时间范围为1年。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 主机集群名 region_name 是 String 局点信息 project_id 是 String 项目id，获取方式请参见获取项目id。 os 是 String 操作系统：windows|linux slave_cluster_id 否 String slave集群id，默认为null时使用默认slave集群，用户自定义slave时为slave集群id description 否 String 描述 is_proxy_mode 否 Integer 主机集群是否为代理机接入模式， 1：是 0：否

请求示例 新建主机集群时需填写基本信息，信息包含主机集群名称、描述、操作系统、是否为代理机接入模式等。 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" : [ ], "app_id" : "88ef50e1d931450989c66adb09acc81d", "is_disable" : true }

请求示例 https://{endpoint}/v3/applications/permissions { "application_ids" : [ "eac65c10c5c34df1824af96ec93a9eea", "3ba2ad194ff141e39b1d3d0749242858" ], "project_id" : "0a38ce9ba3c740c199a0f872b6163661", "roles" : [ { "dev_role_id" : "ba0d4b2e-f7e6-46a3-aece-3002ff640e73", "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 } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id application_ids 是 Array of strings 应用列表 roles 是 Array of AppPermission objects 角色权限 表3 AppPermission 参数 是否必选 参数类型 描述 dev_role_id 是 String 角色id 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 是否具有禁用权限

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 主机集群名称。 约束限制： 不涉及。 取值范围： 只能由中文字符、英文字母、数字及"-"、"_"、"."组成，且长度为[3-128]个字符。 默认取值： 不涉及。 project_id 是 String 参数解释： 项目id，获取方式请参见获取项目id。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 os 是 String 参数解释： 主机集群的操作系统类型。 约束限制： 不涉及。 取值范围： windows：windows操作系统类型。 linux：linux操作系统类型。 默认取值： 不涉及。 slave_cluster_id 否 String 参数解释： slave集群id，默认为空时使用官方资源池，传自托管资源池slave集群id时使用自托管资源池。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为[1-32]个字符。 默认取值： 不涉及。 description 否 String 参数解释： 主机集群描述信息。 约束限制： 不涉及。 取值范围： 字符串，长度为[0-500]个字符。 默认取值： 不涉及。 is_proxy_mode 是 Integer 参数解释： 是否为代理模式主机集群。 约束限制： 不涉及。 取值范围： 0：非代理模式主机集群。 1：代理模式主机集群。 默认取值： 不涉及。

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

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 参数解释： 请求成功、失败状态。 取值范围： success：请求成功。 failed：请求失败。 result HostClusterInfoDetailDetail object 参数解释： 主机集群信息。 取值范围： 不涉及。 表4 HostClusterInfoDetailDetail 参数 参数类型 描述 id String 参数解释： 主机集群id。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 name String 参数解释： 主机集群名称。 取值范围： 只能由中文字符、英文字母、数字及"-"、"_"、"."组成，且长度为[3-128]个字符。 os String 参数解释： 主机集群的操作系统类型。 取值范围： windows：windows操作系统类型。 linux：linux操作系统类型。 slave_cluster_id String 参数解释： 自托管资源池id。 取值范围： 只能由英文字母、数字组成，且长度为[1-32]个字符。 created_by UserInfo object 参数解释： 用户信息，包含用户id、用户名等。 约束限制： 不涉及。 description String 参数解释： 主机集群描述信息。 取值范围： 字符串，长度为[0-500]个字符。 permission PermissionClusterDetail object 参数解释： 主机集群权限信息。 约束限制： 不涉及。 nick_name String 参数解释： 用户昵称。 取值范围： 字符串，长度为[1-30]个字符。 is_proxy_mode Integer 参数解释： 是否为代理模式主机集群。 取值范围： 0：非代理模式主机集群。 1：代理模式主机集群。 created_time String 参数解释： 主机集群创建时间，格式为yyyy-MM-dd HH:mm:ss。例如：'2021-04-01 17:05:53'。 取值范围： 不涉及。 updated_time String 参数解释： 主机集群更新时间，格式为yyyy-MM-dd HH:mm:ss。例如：'2021-04-01 17:05:53'。 取值范围： 不涉及。 表5 UserInfo 参数 参数类型 描述 user_id String 参数解释： 用户id。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 user_name String 参数解释： 用户名。 取值范围： 只能由英文字母、数字组成，且长度为[1-255]个字符。 表6 PermissionClusterDetail 参数 参数类型 描述 can_view Boolean 参数解释： 是否有查看权限。 取值范围： true：有查看权限。 false：无查看权限。 can_edit Boolean 参数解释： 是否有编辑权限。 取值范围： true：有编辑权限。 false：无编辑权限。 can_delete Boolean 参数解释： 是否有删除权限。 取值范围： true：有删除权限。 false：无删除权限。 can_add_host Boolean 参数解释： 是否有添加主机权限。 取值范围： true：有添加主机权限。 false：无添加主机权限。 can_manage Boolean 参数解释： 是否有管理主机集群权限矩阵的权限。 取值范围： true：有管理主机集群权限矩阵的权限。 false：无管理主机集群权限矩阵的权限。 can_copy Boolean 参数解释： 是否有复制主机的权限。 取值范围： true：有复制主机的权限。 false：无复制主机的权限。

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

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

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

响应参数 状态码：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 修改时间

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

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 Array of DynamicConfigInfo objects 部署应用时传递的参数 record_id 否 String 应用的部署id，可通过record_id回滚至之前的部署状态。选中应用历史部署记录，在URL中获取 trigger_source 否 String 限制触发来源,0不限制任何部署请求来源,1时只允许通过流水线触发部署 表4 DynamicConfigInfo 参数 是否必选 参数类型 描述 key 否 String 部署应用时传递的参数名称 value 否 String 部署应用时传递的参数值 type 否 String 类型，如果填写动态参数，则类型必选

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 id String 部署记录id task_id String 部署任务id job_name String 执行任务名称 app_component_list Array of AppComponentDao objects 应用和 AOM 应用组件对应关系 表6 AppComponentDao 参数 参数类型 描述 task_id String 参数解释： 部署任务id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 app_id String 参数解释： AOM应用id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 app_name String 参数解释： AOM应用名称。 取值范围： 由英文字母、数字组成。 comp_id String 参数解释： AOM应用组件id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 comp_name String 参数解释： AOM应用组件名称。 取值范围： 长度为[0,128]个字符。 domain_id String 参数解释： 租户id。 取值范围： 由英文字母、数字组成，且长度为32个字符。 region String 参数解释： 局点信息。 取值范围： 长度为[1,256]个字符。 state String 参数解释： AOM应用组件是否生效。 取值范围： 0: 初始化 1: 执行成功，已生效

响应参数 状态码：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 表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 参数解释： 用户信息，包含用户id、用户名等。 约束限制： 不涉及。 permission EnvironmentPermissionDetail object 环境权限详情 表5 UserInfo 参数 参数类型 描述 user_id String 参数解释： 用户id。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 user_name String 参数解释： 用户名。 取值范围： 只能由英文字母、数字组成，且长度为[1-255]个字符。 表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 } } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id permission_level 是 String 应用鉴权级别，instance：实例级；project：项目级 application_ids 是 Array of strings 应用id列表

请求示例 https://{endpoint}/v3/applications/permission-level { "application_ids" : [ "eac65c10c5c34df1824af96ec93a9eea", "3ba2ad194ff141e39b1d3d0749242858" ], "project_id" : "0a38ce9ba3c740c199a0f872b6163661", "permission_level" : "instance" }

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