项目 描述 存储池名称 存储池名称。 ：表示是基础存储池。 状态 存储池状态： 正常。 删除中。 故障域级别 存储池故障域级别： 数据目录级别。 服务器级别。 机架级别。 机房级别。 容量 存储池总容量。 缓存存储池卷 使用该存储池作为缓存存储池的卷。 存储池卷 使用该存储池作为存储池的卷。 卷存储模式：个数/容量 各种模式卷对应的个数及卷总容量。

了解存储资源盘活系统的集群拓扑。 点击导航栏中的“系统”>“集群拓扑”， 进入“集群拓扑”页，可以查看HBlock的集群拓扑图。 集群拓扑是对集群物理资源实际部署方式的可视化逻辑展示。

项目 描述 存储池名称 存储池名称。 数据目录（总量/已用/使用率） 存储池中所有数据目录所在磁盘的总容量、已用容量、使用率的平均值。 容量配额（总量/已用/使用率） 存储池中所有数据目录的HBlock容量配额总量、已用容量配额、容量配额使用率的平均值。 带宽（总/读/写） 客户端与服务器之间的总带宽、读带宽、写带宽。

请求语法 plaintext PUT /rest/v1/system/server/serverId/migrate HTTP/1.1 Date: date ContentType: application/json; charsetutf8 ContentLength: length Host: ip:port Authorization: authorization { "destServerId": serverId, "service": service, "metaDir": path } 请求参数 参数 类型 说明 是否必须 serverId String 源HBlock服务器的ID。 是 destServerId String 目的服务器ID。 是 service String 需要迁移的基础服务。 取值： mdm：元数据管理服务。 ls：日志服务。 cs：协调服务。 是 metaDir String 迁移服务的数据目录，用于存储基础服务的相关数据信息。 说明 为了提升读写性能，建议各基础服务的数据目录、安装目录、存储数据的数据目录相互独立。 取值：只能包含字母、数字、汉字和特殊字符(~ ! @ $ ( ) + ; . :)。默认目录为安装目录。 否 请求示例 将mdm服务从服务器hblock3迁移至服务器hblock1。 plaintext PUT /rest/v1/system/server/hblock3/migrate HTTP/1.1 Date: Mon, 22 Jun 2026 09:58:44 GMT ContentType: application/json Authorization: HBlock userName:signature Connection: keepalive ContentLength: 59 Host: 192.168.0.65:1443 { "destServerId": "hblock1", "service": "mdm" } 响应示例 plaintext HTTP/1.1 202 Accepted xhblockrequestid: 6130422f6b7c47e9b835cd34c751aaa1 Connection: keepalive ContentLength: 178 Date: Mon, 22 Jun 2026 09:58:45 GMT ContentType: application/json;charsetutf8 Server: HBlock { "data": { "message": "Due to topology changes or service adjustments across the entire cluster, please restart the services on the following servers:nhblock1: psnhblock3: ps" } }

本节主要介绍如何使用API查询指定存储池。 此操作用来查询指定存储池。 请求语法 plaintext GET /rest/v1/system/storagepool/poolName HTTP/1.1 Date: date ContentType: application/json; charsetutf8 Host: ip:port Authorization: authorization 请求参数 参数 类型 描述 是否必须 poolName String 存储池名称。 取值：长度范围是1~16，只能由字母、数字和短横线（）、下划线（）组成，字母区分大小写，且仅支持以字母和数字开头。 是 响应结果 名称 类型 描述 name String 存储池名称。 id Short 存储池序号。 isBasePool Boolean 是否是基础存储池： true：是基础存储池。 false：不是基础存储池。 status String 存储池状态： Normal：正常。 Deleting：删除中。 faultDomain String 存储池故障域级别： path：数据目录级别。 server：服务器级别。 rack：机架级别。 room：机房级别。 description String 存储池描述信息。 totalCapacity Long 存储池总容量，单位是bytes。 usedCapacity Long 存储池已用容量，单位是bytes。 usedCapacityQuota Long 存储池已用容量配额，单位是bytes。 capacityQuota Long 存储池容量配额，单位是bytes。 createTime Long 存储池创建时间。 luns.lunNamesForCachePool Array of lunNamesForCachePool 缓存存储池卷列表。 luns.lunNamesForPool Array of lunNamesForPool 存储池卷列表。 luns.status Object 卷的状态信息，详见“表1 响应参数luns.status说明”。 topology Array of topology 存储池拓扑信息集合，详见“表2响应参数topology/childNode说明”。 qosPolicy.qosName String 存储池关联的QoS策略名称。 qosPolicyforLUN.qosName String 存储池内卷的默认QoS策略名称。 dataHealth.normal Double 该存储池所有卷正常数据的百分比。 dataHealth.lowRedundancy Double 该存储池所有卷降级数据的百分比。 dataHealth.error Double 该存储池所有卷错误数据的百分比。 dataHealth.reconstructionProgress Double 如果该存储池卷存在降级状态的数据，数据重建进度的百分比。 dataHealth.ETR Long 如果该存储池卷存在降级数据，预计剩余的数据重建时间。单位为秒。如果返回值为负数，说明数据无法重建，需用户尽快修复。 表1 响应参数luns.status说明 名称 类型 描述 number Integer 存储池关联卷的个数。 cacheNumber Integer 缓存模式卷的个数。 storageNumber Integer 存储模式卷的个数。 localNumber Integer 本地模式卷的个数。 cacheCapacity Long 缓存模式卷容量，单位是bytes。 storageCapacity Long 存储模式卷容量，单位是bytes。 localCapacity Long 本地模式卷容量，单位是bytes。 表2 响应参数topology/childNode说明 名称 类型 描述 name String 拓扑节点或者子节点名称。 fullname String 拓扑节点或者子节点的全路径名称。 type String 拓扑节点或者子节点的类型： room：机房。 rack：机架。 server：服务器。 path：数据目录。 description String 拓扑节点或子节点的描述信息。 如果未添加描述信息，或者节点类型是path，不返回此项。 healthStatus String 故障域状态： Healthy：健康状态，可正常读写。 Warning：警告状态，可读。 Error：错误状态，无法访问。 childNodes Array of childNode 拓扑图中子节点，childNode 和topology基本一致，类型不同，包含的内容不同，详见本表其他字段。 如果topology 或者childNode 的类型是server clusterAddress String 拓扑图集群网络IP。 如果topology 或者childNode 的类型是server publicAddress String 拓扑图业务网络IP。 如果topology 或者childNode 的类型是server allDiskPaths.usedCapacity Long 拓扑图中所有数据目录的已用容量。 如果topology 或者childNode 的类型是server allDiskPaths.totalCapacity Long 拓扑图中所有数据目录的总容量。 如果topology 或者childNode 的类型是server serverStatus String 拓扑图的服务器状态： Connected：已连接。 Disconnected：未连接。 Removing：移除中。 如果topology 或者childNode 的类型是server serverId String 拓扑图的服务器ID。 如果topology 或者childNode 的类型是server childNodes Array of childNodes 拓扑图中子节点，childNode 和topology基本一致，类型不同，包含的内容不同，详见本表其他字段。 如果topology 或者childNode 的类型是path usedCapacity Long HBlock数据目录对应分区的已用容量，单位是bytes。 如果topology 或者childNode 的类型是path totalCapacity Long HBlock数据目录对应分区的总容量，单位是bytes。 如果topology 或者childNode 的类型是path usedCapacityQuota Long 数据目录已用容量配额，单位是bytes。 如果topology 或者childNode 的类型是path capacityQuota Long 数据目录容量配额，单位是bytes。 如果topology 或者childNode 的类型是path managementStatus String 数据目录的管理状态： Added：已添加。 Removing：正在移除。 如果topology 或者childNode 的类型是path healthStatus String 数据目录健康状态： Healthy：数据目录处于健康状态，可正常读写，且数据目录所在磁盘使用率未超过阈值（系统默认值为95%）。 Warning：：数据目录处于警告状态，可读，但存在以下情况的任意一种：慢盘；数据目录所在磁盘使用率超过阈值（系统默认值为95%）；磁盘剩余空间不足1GiB；HBlock对这个目录停写；数据目录配额使用率超过阈值（系统默认值为95%）；数据目录配额为0。 Error：数据目录错误状态，无法访问，原因可能是：所在磁盘出现I/O错误导致无法读写，数据目录未正确挂载等。 如果topology 或者childNode 的类型是path healthDetail Array of string 数据目录健康状态详情： 如果健康状态为Healthy，此字段为空。 如果健康状态为Warning或Error，显示警告或错误的详细信息。 如果topology 或者childNode 的类型是path serverId String 数据目录所属的服务器ID。

HTTP status 错误码 错误信息 描述 400 CanNotAddNodeToPool The node nodeName has no available paths added to storage pool poolname . 该节点没有可用的path节点添加到存储池。 400 CanNotDeleteBasePool The storage pool with name poolName can not be deleted. It is a base pool. 无法删除基础存储池。 400 CanNotDeleteNode The node nodeName can not be deleted. Please remove its child nodes and try again. 该节点不能移除，需要先移除它的子节点后才能移除该节点。 400 CanNotDeleteRootNode The type of node nodeName is root, it cannot be deleted. 不能删除根节点。 400 CanNotMoveNode The node nodeName can not be moved. Please make sure the node type is not lower than the fault domain level of storage pool which its leaf node belongs to. 节点不满足重新映射条件，请修改后重试。 400 DuplicatedNode The node with name nodeName is not unique in the topology. 节点名称在集群中不唯一。 400 ExceedThreshold The number of operation cannot exceed value . 超出了系统允许的最大个数，无法执行该操作。 400 InvalidEnumValue Value value at 'node type' failed to satisfy constraint: Argument must satisfy enum value set: [ value1, value2... ] 节点类型错误，不符合枚举值。 400 InvalidFile Failed to parse file filename . 文件格式不正确。 400 InvalidNodeName Value value at 'node name' failed to satisfy constraint: Argument must contain only letters, digits, dots (.), underscores () or hyphens (), and does not exceed 63 characters, must begin with a letter or digit. 节点名称不正确。长度范围1~63，只能由字母、数字、句点(.)、下划线（）和短横线()组成，字母区分大小写，且仅支持以字母或数字开头。 400 InvalidNodeType Value value at 'node type' failed to satisfy constraint: the first node type must be root. 节点类型的包含关系错误，第一个节点必须是root。 400 InvalidNodeType Value value at 'node type' failed to satisfy constraint: childNodes of room are limited to [rack, server], childNodes of rack to [server], childNodes of server to [path] only. 节点类型的包含关系错误。room的节点仅限于rack、server，机架的子节点是server，server的子节点是path。 400 InvalidPathStatus The path path status is ' status ', the request is invalid. 数据目录状态不正确，无法执行操作。 400 InvalidPoolName Value value at 'pool name' failed to satisfy constraint: Argument must contain only letters, digits, underscores () or hyphens (), and does not exceed 16 characters, must begin with a letter or digit. 存储池名称不正确。 400 InvalidTopology Failed to parse topology. 拓扑格式不符合要求。 400 InvalidTopologyContent The content of the topology is not compliant. 拓扑文件内容解析错误。 400 InsufficientPath The base storage pool must have at least one disk path. 基础存储池至少要有一个数据目录。 400 LUNCorruptedRisk There is a LUN with redundancy mode, which has the minimum requirement for the number of fault domains. LUN: lunName1 [, lunName2.... ] Removing the node may cause data loss. You can use force remove. When using this option, there may be a risk of data loss. 节点移除后会造成卷数据损毁：lunName1[, lunName2....]。移除节点可能会引起数据丢失。只能使用强制移除。请注意，强制移除，会产生数据丢失风险，请谨慎操作。 400 LUNExists There are LUNs in this storage pool Please delete all LUNs and try again. 存储池关联的卷不存在。 400 MissingRequiredAncestorNode The node nodeName has no ancestor node with type nodetype . 没有对应的父节点类型。 400 MissingRequiredDescendantNode The node nodeName has no descendant node with type nodetype . 没有对应的子节点类型。 400 NodeAlreadyExists The node with name nodeName has already exists in the topology. 节点名称已经在拓扑图中存在。 400 NodeNotAllowed The type of node nodeName is type, the request is invalid. 节点名称和节点类型不匹配。 400 NoSuchFile The file with name filename does not exist. 文件不存在。 400 NoSuchNode The node with name nodeName does not exist. 节点不存在。 400 NoSuchStoragePool The storage pool with name poolName does not exist. 存储池不存在。 400 NodeTypeNotMatch Node type does not match. Please check parent node type. 节点类型不匹配，请检查父节点。 400 PathConflict Can not use path pathName because it belongs to another storage pool. 不能添加该节点，因为该节点已经属于其他存储池。 400 PermissionDenied Failed to action because user has no permission. 用户的权限不足，无法执行操作。 400 PoolAlreadyExists The storage pool with name poolName already exists. 存储池名字已经存在。 400 RemoveFaultDomainRisk Can not remove multiple fault domains at the same time. You can use force remove. When using this option, there may be a risk of data loss. 无法同时移除的多个故障域。 400 RemoveNodeRisk The node nodeName or its child nodes are being used by a storage pool. Removing the node may cause data loss. You can use force remove. When using this option, there may be a risk of data loss. 移除节点可能会引起数据丢失。只能使用强制移除。请注意，强制移除，会产生数据丢失风险，请谨慎操作。 400 SamePool Cannot use the same storage pool poolName. 不能使用名字相同的存储池。 400 StandaloneModeNotAllowed ' operation ' is not supported by standalone mode of HBlock. 单机版本HBlock不支持该操作。 400 SystemCrashRisk The node nodename can not be removed because there is only one available fault domain left in the base storage pool, or the node is related to multiple fault domains in the base pool, removing node may result in a system crash. 无法移除节点，存在以下情况之一，移除节点可能引发系统崩溃：基础存储池仅剩一个可用故障域时，无法移除故障域内的任何节点；节点涉及基础存储池的多个故障域。 409 InvalidPoolStatus The status of storage pool poolName is 'status', the request is invalid. 存储池当前的状态不正确，请求无效。

名称 类型 描述 name String 拓扑节点名称。 fullname String 节点在集群中的全路径名称，从根节点开始，使用name:name:name格式来唯一标识该节点的名称。 id String 拓扑节点ID。 type String 节点的类型：root：根节点。 description String 节点描述。 childNodes Array of childNodes 子节点信息集合，根据子节点类型不同，展示的信息不同，详见“ 表1响应参数ChildNode说明 ”。

请求示例 查询存储池中包含pool的存储池。 plaintext GET /rest/v1/system/storagepool?filterpoolName:pool HTTP/1.1 Date: Wed, 31 Dec 2025 09:23:34 GMT ContentType: application/json; charsetutf8 Authorization: HBlock userName:signature Host: 192.168.0.64:1443 响应示例 plaintext HTTP/1.1 200 OK xhblockrequestid: e35107c99bf0466eb46362c4858cbc3b Connection: keepalive ContentLength: 2727 Date: Wed, 31 Dec 2025 09:23:34 GMT ContentType: application/json;charsetutf8 Server: HBlock { "data": { "storagePool": [ { "name": "pool1", "id": 0, "isBasePool": true, "status": "Normal", "faultDomain": "server", "totalCapacity": 299111325696, "usedCapacity": 4151316480, "usedCapacityQuota": 3298676875, "capacityQuota": 299111325696, "createTime": 1766021671041, "luns": { "lunNamesForCachePool": [], "lunNamesForPool": [ "lun04c", "lun01aC1", "lun03a", "lun040012", "lun04a", "luncloud", "lun01a", "lun01b" ], "status": { "number": 8, "cacheNumber": 1, "storageNumber": 3, "localNumber": 4, "cacheCapacity": 515396075520, "storageCapacity": 784905273344, "localCapacity": 505732399104 } }, "topology": [ { "name": "hblock1", "fullname": "default:hblock1", "type": "server", "healthStatus": "Healthy", "clusterAddress": "192.168.0.65", "publicAddress": "192.168.0.65", "allDiskPaths": { "usedCapacity": 1815838720, "totalCapacity": 99703775232 }, "serverStatus": "Connected", "serverId": "hblock1", "childNodes": [ { "name": "/mnt/stor01", "fullname": "default:hblock1:/mnt/stor01", "type": "path", "usedCapacity": 1815838720, "totalCapacity": 99703775232, "usedCapacityQuota": 1100965008, "capacityQuota": 99703775232, "managementStatus": "Added", "healthStatus": "Healthy", "healthDetail": [], "serverId": "hblock1" } ] }, { "name": "hblock2", "fullname": "default:hblock2", "type": "server", "healthStatus": "Healthy", "clusterAddress": "192.168.0.64", "publicAddress": "192.168.0.64", "allDiskPaths": { "usedCapacity": 1134886912, "totalCapacity": 99703775232 }, "serverStatus": "Connected", "serverId": "hblock2", "childNodes": [ { "name": "/mnt/stor02", "fullname": "default:hblock2:/mnt/stor02", "type": "path", "usedCapacity": 1134886912, "totalCapacity": 99703775232, "usedCapacityQuota": 1100928144, "capacityQuota": 99703775232, "managementStatus": "Added", "healthStatus": "Healthy", "healthDetail": [], "serverId": "hblock2" } ] }, { "name": "hblock3", "fullname": "default:hblock3", "type": "server", "healthStatus": "Healthy", "clusterAddress": "192.168.0.67", "publicAddress": "192.168.0.67", "allDiskPaths": { "usedCapacity": 1200590848, "totalCapacity": 99703775232 }, "serverStatus": "Connected", "serverId": "hblock3", "childNodes": [ { "name": "/mnt/stor01", "fullname": "default:hblock3:/mnt/stor01", "type": "path", "usedCapacity": 1200590848, "totalCapacity": 99703775232, "usedCapacityQuota": 1096783723, "capacityQuota": 99703775232, "managementStatus": "Added", "healthStatus": "Healthy", "healthDetail": [], "serverId": "hblock3" } ] } ], "qosPolicy": { "qosName": "QoS1" }, "qosPolicyforLUN": { "qosName": "QoS1" }, "dataHealth": { "normal": 100, "lowRedundancy": 0, "error": 0 } }, { "name": "pool2", "id": 1, "isBasePool": false, "status": "Normal", "faultDomain": "server", "totalCapacity": 0, "usedCapacity": 0, "usedCapacityQuota": 0, "capacityQuota": 0, "createTime": 1766384595246, "luns": { "lunNamesForCachePool": [], "lunNamesForPool": [], "status": {} }, "topology": [], "dataHealth": { "normal": 100, "lowRedundancy": 0, "error": 0 } } ] } }

接口功能介绍 请将云电脑中的敏感数据删除之后再检测，避免数据安全隐患。 请勿在检测过程中对所选云电脑及其相关资源进行其他操作。 自定义镜像检测会花费10分钟左右。 接口约束 无 URI POST /v3/customImage/preCheck 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx desktopOid 是 String 云电脑OID 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 noticeSuccess Boolean 通知是否成功 true errorMsg String 错误信息 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "noticeSuccess":true, "errorMsg":"" } }

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

接口功能介绍 请将云电脑中的敏感数据删除之后再检测，避免数据安全隐患。 请勿在检测过程中对所选云电脑及其相关资源进行其他操作。 自定义镜像检测会花费10分钟左右。 接口约束 无 URI POST /v3/customImage/getCheckResult 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx desktopOid 是 String 云电脑OID 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 agentCallBackCode Integer 不同的值表示不同的检测进度，0表示发起检测成功，其他表示失败，具体如下：7，表示桌面检测过程中在线运行；6，表示未知错误；5，表示第一次接收检测结果超时；4，表示桌面开机失败；3，表示桌面开机中；其他表示检测超时未收到检测结果； errorMsg String 错误信息 mirrorCheckRemark String 最终是否检测成功的唯一判断标识，检测结果，success表示通过，failure表示失败 schedule Integer 检测进度，百分比数，例如：60，表示检测60% mirrorCheckResult Array of Objects 每项检测详情 mirrorCheckResult 表 mirrorCheckResult 参数 参数类型 说明 示例 下级对象 name String 检测项标题 mustCheck Boolean 是否必须检测项 result Integer 检测结果，0表示检测不通过，1表示检测通过，2检测中，3检测超时 reason String 检测不通过的原因 msg String 检测不通过的信息提示 solution String 检测不通过时的解决方案

接口功能介绍 设置密码定期强制更新v3 接口约束 无 URI POST /v3/commonSetting/setPasswordForceUpdateCycle 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 passwordForceUpdateCycle 是 String 密码定期强制更新。可强制要求用户在指定周期内修改密码。可能值： Unlimited：取消密码定期强制更新。 OneMonth：一个月。 ThreeMonths：三个月。 SixMonths：六个月。 TwelveMonths：十二个月。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "passwordForceUpdateCycle":"Unlimited" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

接口功能介绍 设置手机号必填v3 接口约束 无 URI POST /v3/commonSetting/setPhoneRequired 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 phoneRequired 是 Boolean 手机号必填。可限制账号激活或绑定时，手机号是否作为必要输入条件；true 表示开启，false 表示关闭。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "phoneRequired":true } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 设置用户绑定手机号邮箱v3 接口约束 无 URI POST /v3/commonSetting/setUserBinding 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userBindingEnabled 是 Boolean 用户绑定手机号邮箱。可限制管理台创建的用户在客户端绑定手机号、邮箱的操作；true 表示开启，false 表示关闭。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "userBindingEnabled":true } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

接口功能介绍 设置管理员联系方式v3 接口约束 无 URI POST /v3/commonSetting/setAdminContacts 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 adminContacts 是 Array of Objects 管理员联系方式。相应信息会在客户端展示，方便企业成员联系管理员开通功能或排查问题；最多 20 个联系人；空数组表示清空管理员联系方式。 adminContacts 表 adminContacts 参数 是否必填 参数类型 说明 示例 下级对象 name 是 String 联系人姓名。不能为空字符串，字符数限制[1,20]。 phoneNumber 否 String 联系人手机号。手机号和邮箱至少填写一个；填写时不能为空字符串，且格式必须正确。 email 否 String 联系人邮箱。字符数限制[1,50]；手机号和邮箱至少填写一个；填写时不能为空字符串，且格式必须正确。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

本机介绍天翼云电脑在使用过程遇到问题,可通过检测工具进行自助检测和修复的操作。 在使用天翼AI云电脑过程中如果遇到无法上网、核心组件异常、使用卡顿等问题，可使用AI云电脑检测工具进行自助检测和修复问题，获取良好的使用体验。操作流程如下： 1. 可通过桌面图标或“开始菜单”启动AI云电脑检测工具，若未找到检测工具应用，请在天翼AI云电脑应用市场下载。 2. 启动检测工具后，点击【立即体检】。在这过程中，工具将针对AI云电脑网络、组件服务、应用软件进行检测，并展示异常问题。若出现部分项目显示被“跳过”，是由于其依赖于前置问题的修复，可能需要进行多次的检测与修复操作。 3. 体检完成后，点击【一键修复】，工具将对异常项进行自动修复，显示最终修复情况。（注意：用户【忽略】的异常项，工具将不对其进行修复。部分异常若被忽略（如忽略网络模块中的硬件问题），将导致该模块的其余项目无法正常检修，建议谨慎操作。）

本节介绍了移动办公使用的最佳实践介绍。 天翼AI云电脑支持手机、Pad等多种移动终端，使用3/4/5G、WIFI网络登录AI云电脑，即可随时随地访问AI云电脑资源，随时进行收发文件，及时处理办公问题，实现移动办公。 前提条件 已开通天翼AI云电脑，详情请参见快速订购AI云电脑。 注意事项 天翼AI云电脑支持多终端适配：适配PC、Mac、iOS、安卓等多种终端，多外设支持：鼠标、键盘、打印机、扫描仪等外设无缝衔接（备注：手机、Pad等移动终端不支持USB外设），详情可查看外设兼容性建议清单。 应用场景说明 其常用方式： 1. 外出无需携带电脑，通过手机等移动客户端接入AI云电脑进行操作，轻松调用云端资源进行移动办公； 2. 天翼AI云电脑客户端支持接入扩展坞、键盘、鼠标等主流外设，与传统PC一致的使用体验。 操作步骤 步骤一：以天翼AI云电脑移动客户端为例，帮助您快速登录连接AI云电脑。步骤详见：登录连接AI云电脑 执行结果 当用户通过手机等移动客户端接入AI云电脑进行操作，轻松调用云端资源进行移动办公。例如：文档编辑，邮件接收和发送，浏览网页，日程办公软件使用等场景都可以轻松实现。

本节介绍TeleAgent如何配置第三方API Key的操作说明。 前置准备 您已获取目标API服务商的 API Key、基础URL 和 模型ID（如云智助手 Token的API凭证，详见“如何获取云智助手 Token”）。 操作步骤 1.打开桌面“TeleAgent”应用，在主界面选择 “设置”； 2.在窗口左侧菜单栏中，选择 “模型设置”，点击“添加模型服务商”； 3.填写API配置信息； 在弹出的“添加模型服务商”窗口中，按以下字段填入您准备好的凭证： API地址：粘贴您的API基础地址 API密钥：粘贴您的访问密钥 模型ID：粘贴您要使用的模型ID 4.配置完成后，返回TeleAgent主界面。您将在模型选择区域看到已添加的服务商名称，表示配置成功，即可正常使用该API进行代码生成、对话等操作。

本节介绍WorkBuddy如何配置第三方API Key的操作说明。 前置准备 您已获取目标API服务商的API Key、基础URL和模型ID（如云智助手赠送Token的API凭证，详见“如何获取云智助手 Token”）。 操作步骤 1.打开桌面“WorkBuddy”应用，在模型选择区域选择 “配置自定义模型”； 2.进入添加模型窗口，选择“自定义”供应商； 3.填写API配置信息； 在弹出的“添加供应商”窗口中，按以下字段填入您准备好的凭证： 接口地址：粘贴您的API基础地址 API Key：粘贴您的访问密钥 模型名称：粘贴您要使用的模型ID 4.确认信息无误后，点击 “保存” 按钮，系统将保存该配置； 5.配置完成后，返回WorkBuddy主界面。您将在模型选择区域看到已添加的服务商名称，表示配置成功，即可正常使用该API进行代码生成、对话等操作。

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj

充值 为防止相关资源不被停止或者释放，请及时进行充值，为避免帐号将进入欠费状态，需要在约定时间内支付欠款，详细操作请参考费用中心资金管理余额充值用户充值。

状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 tenantId 是 String 注册天翼云账号的accountId，也叫tenantId。从 概览页面中账号信息栏获取，“当前身份”对应tenantId。 e974b0438b814fc08ec8e499643e530f userid 是 String 注册天翼云账号的userid，也叫assumeUserId。从 概览页面中账号信息栏获取，“当前用户”对应userid。 60b0d272307d408dacda2b16060962c8

参数 是否必填 参数类型 说明 示例 下级对象 tenantId 是 String 注册天翼云账号的accountId，也叫tenantId。从 概览页面中账号信息栏获取，“当前身份”对应tenantId。 e974b0438b814fc08ec8e499643e530f userid 是 String 注册天翼云账号的userid，也叫assumeUserId。从 概览页面中账号信息栏获取，“当前用户”对应userid。 60b0d272307d408dacda2b16060962c8

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码 取值范围：800 成功 900失败 800 error String 接口访问失败的错误码，CTWAF0001表示参数错误，CTWAF0002表示业务错误 CTWAF0001 message String 接口访问成功或失败的描述信息 成功！ returnObj Object 返回对象 returnObj

枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "billMode":"Cycle", "cycleType":3, "cycleCnt":1, "resourcePackOid":"resxxx", "osType":"Linux", "templateOid":"temxxx", "imageOid":"mixxx", "subnetOid":"snxxx", "securityGroupOid":"sgxxx", "sysDiskType":"uhio", "sysDiskSize":120, "password":"A1@a288", "instanceNum":1 } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "newOrderNo":20250718141255003733, "newOrderId":"29471d1d08694681ad87ebf95e29e71a", "totalPrice":95.1, "operations":[{ "operationId":"joborderabc7211cb74fbb283e42809d2c" }] } } 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

典型应用场景 Hermes内置浏览器工具和十余种常用Skills，涵盖文件管理，系统优化，信息获取和内容创作等办公全场景，告别手动操作实现智能自动化； 1. 批量整理文件：自动将散乱的项目文档分类归档（视频，软件，笔记，文档），并生成整理报告。 2. 电脑加速：自动诊断系统性能问题并给出优化建议，接受指令一键释放系统缓存和关闭不用的后台服务。 3. 获取热门资讯：自动全网搜索指定的领域新闻，整理分类并生成MD格式的文档，保存到指定的路径。 4. 网页程序：无需代码基础，自动编写HTML文档，生成可直接运行的网页。 5. 撰写材料：根据提示自动检索互联网相关内容并生成结构清晰的办公文档，支持多种文件格式（Word，PPT，Excel等）。 进阶操作 1. 安装skills：直接对Hermes说帮我安装xxx技能，Hermes便会自动完成skill搜索，安装并加载，完成后即可直接使用。 2. 使用“/”命令：在输入对话框中可以直接输入“/”，可以唤醒Hermes系统指令包括（切换模型，新建会话，切换Agent人设，回滚消息，罗列技能列表等）；也可直接指定本次消息使用的技能。 3. 配置更多IM通道：打开系统终端输入“hermes gateway setup”，可配置更多IM通道，配置完选择重启后台服务即可生效。 4. 打开终端对话：Hermes自带终端对话，只要打开系统终端并输入“hermes”即可进入，可以享受最极客的对话体验。