华为云用户手册

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

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

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 主机数量 group_name String 主机集群名称 hosts Array of DeploymentHostDetail objects 主机列表信息 表5 DeploymentHostDetail 参数 参数类型 描述 group_id String 主机集群id 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主机） host_id String 主机id proxy_host DeploymentHostDetail object 代理机信息详情 group_name String 主机集群名 project_id String 项目id，获取方式请参见获取项目id。 project_name String 项目名称 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 用户名，可输入中英文，数字和符号(-_.)。 password String 密码，认证类型为0时，密码必填。 private_key String 密钥，认证类型为1时，密钥必填 trusted_type Integer 认证类型，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 limit 否 Integer 每页显示的条目数量，默认为1000 name 否 String 主机名，可输入中英文，数字和符号(-_.) 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：升序排序 with_auth 否 Boolean 返回结果是否加密

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 主机集群名 description 否 String 描述 slave_cluster_id 否 String 自定义slave资源池id auto_connection_test_switch 否 Integer 自动测试功能已下架，该字段已失效

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

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

请求示例 文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4ddw"，目录的全路径是“/data/test”, 删除目录quota DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4ddw/fs/dir-quota { "path" : "/data/test" }

响应示例 状态码：200 任务下发成功 { "count" : 1, "targets" : [ { "target_id" : "00000334-xxxx-402d-a5d4-bxxxxx87b939", "creation_time" : "2023-10-10T12:02:03", "file_system_path" : "sfsturboDirName", "obs" : { "bucket" : "myBucket", "endpoint" : "obs.region.example.com" } } ] } 状态码：404 错误响应 { "errCode" : "SFS.TURBO.0002", "errMsg" : "share not exist" } 状态码：500 错误响应 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

URI GET /v1/{project_id}/sfs-turbo/shares/{share_id}/targets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID share_id 是 String 文件系统ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询列表返回元素个数 marker 否 String 查询列表偏移量

请求示例 查询文件系统后端存储列表，文件系统ID为"630509b1-ded4-476e-8d06-dbbc3dc23900", 从target_id为"11abef677ac40f46644d1d5cfc2424a4"起，获取10个后端存储 GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/630509b1-ded4-476e-8d06-dbbc3dc23900/targets?marker=11abef677ac40f46644d1d5cfc2424a4&limit=10

响应参数 状态码：200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表5 响应Body参数 参数 参数类型 描述 count Integer 后端存储列表个数 targets Array of ShowBackendTargetInfoResponseBody objects 后端存储列表 表6 ShowBackendTargetInfoResponseBody 参数 参数类型 描述 target_id String 绑定关系ID creation_time String 绑定关系创建时间 file_system_path String 联动目录名称 failure_details FailureDetailsMessage object 绑定错误信息 lifecycle String 绑定状态 枚举值： CREATING AVAILABLE MISCONFIGURED DELETING FAILED obs ObsDataRepository object OBS类型后端存储 表7 FailureDetailsMessage 参数 参数类型 描述 message String 错误信息 表8 ObsDataRepository 参数 参数类型 描述 bucket String OBS桶名称 endpoint String OBS桶所在的区域 域名 policy ObsDataRepositoryPolicy object 后端存储自动同步策略 attributes ObsTargetAttributes object 后端存储属性。2024年6月30日及之前创建，且未升级的文件系统版本不支持该参数，请提工单处理。 表9 ObsDataRepositoryPolicy 参数 参数类型 描述 auto_export_policy AutoExportPolicy object 后端存储自动导出策略。当文件系统发生数据更新时，将自动导出到OBS桶。 表10 AutoExportPolicy 参数 参数类型 描述 events Array of strings 后端存储自动导出到OBS桶的数据更新类型。 NEW：表示新增数据，SFS Turbo联动目录下创建的文件，及之后对这些文件进行的元数据和数据修改，会被自动同步到OBS桶里。 CHANGED：表示修改数据，从OBS桶里导入到SFS Turbo联动目录下的文件，在SFS Turbo上对这些文件所进行的数据和元数据的修改，会被自动同步到OBS桶里。 DELETED：表示删除数据，在SFS Turbo联动目录下删除文件，OBS桶对应的对象也会被删除，只有被SFS Turbo写入的OBS对象才会被删除。 枚举值： NEW CHANGED DELETED prefix String 后端存储内对象匹配前缀 suffix String 后端存储内对象匹配后缀 表11 ObsTargetAttributes 参数 参数类型 描述 file_mode Integer 导入的文件权限。取值范围是0到777。 第一位表示文件所有者的权限，取值范围是0到7；第二位表示文件所属用户组的权限，取值范围是0到7；第三位表示其他用户的权限，取值范围是0到7。文件所有者由uid指定，文件所属用户组由gid指定，不是文件所有者且不在文件所属用户组的用户为其他用户。 数字4、2、1分别表示读、写、执行权限，这些数字相加，即可得到所需的权限组合。例如：750中第一位7代表该文件所有者对该文件具有读、写、执行权限；第二位5代表该文件所属用户组对该文件具有读、执行权限；第三位0代表其他用户对该文件无权限。 dir_mode Integer 导入的目录权限。取值范围是0到777。 第一位表示目录所有者的权限，取值范围是0到7；第二位表示目录所属用户组的权限，取值范围是0到7；第三位表示其他用户的权限，取值范围是0到7。目录所有者由uid指定，目录所属用户组由gid指定，不是目录所有者且不在目录所属用户组的用户为其他用户。 数字4、2、1分别表示读、写、执行权限，这些数字相加，即可得到所需的权限组合。例如：750中第一位7代表该目录所有者对该目录具有读、写、执行权限；第二位5代表该目录所属用户组对该目录具有读、执行权限；第三位0代表其他用户对该文件无权限。 uid Integer 导入对象所有者的用户id，默认值是0，取值范围是0到4,294,967,294（即2^32-2）。 gid Integer 导入对象所属用户组id，默认值是0，取值范围是0到4,294,967,294（即2^32-2）。 状态码：404 表12 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表13 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

请求示例 文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4ddw"，目录的全路径是“/data/test”，查询该目录的quota值 GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4ddw/fs/dir-quota?path=/data/test

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 path String 合法的已存在的目录的全路径 capacity Integer 目录的容量大小，单位：MB inode Integer 目录的inode数量限制 used_capacity Integer 目录已使用的容量大小，单位：MB。仅SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB返回该字段。数据可能有延迟。 used_inode Integer 目录的已使用的inode数量。仅SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB返回该字段。数据可能有延迟。 状态码：400 表5 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码：500 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述