本节主要介绍移除服务器命令。 ./stor server rm { n server } SERVERID [ d deldata ] [ f force ] 此命令用来从HBlock集群中移除服务器。 注意 如果移除服务器上有Target，该Target对应卷的高可用类型是ActiveStandby，移除服务器时，业务不会中断，此卷对应的Target会切换到其他服务器上，客户端需要重新连接Target对应的新服务器IP。 如果移除服务器上有Target，该Target对应卷的高可用类型是Disabled，移除服务器时，业务会中断，此卷对应的Target会切换到其他服务器上，客户端需要重新连接Target对应的新服务器IP。但服务器移除时，会有数据丢失风险。 如果执行日志采集后，产生的日志保存在服务器安装目录下，在服务器移除之后，该日志将被删除。如果产生的日志保存在HBlock的数据目录内，并且移除服务器时删除服务器HBlock数据目录中的数据，该日志也将被删除。 有服务器正在移除时，不能再移除其他服务器。如果必须移除，请使用强制移除，但有丢数据风险。 该节点的所有数据目录不属于任何存储池，允许移除该服务器。否则不能移除，如果必须移除，请使用强制移除，但有丢数据风险。 如果要移除服务器的某个数据目录属于基础存储池，且是基础存储池中仅剩的一个可用故障域中的节点，不允许移除。 如果服务器上有基础服务，不允许移除。 参数 参数 描述 n SERVERID 或 server SERVERID 要移除服务器的ID。 d 或 deldata 移除服务器时，删除服务器上HBlock数据目录中的数据。 f 或 force 强制移除服务器。 注意 强制移除服务器，可能造成数据丢失。

参数 描述 s SERVERIP [: PORT ] 或 server SERVERIP [: PORT ] 添加服务的IP（ SERVERIP ）及API端口号（ PORT ）。 服务器IP：IPv4或[IPv6]。 API端口号：取值范围是[1, 65535]，默认值为1443。需要和该服务器安装HBlock时设置的API端口号保持一致。 parentnode PARENTNODE 指定父节点。 默认为根节点。 n NODENAME 或 name NODENAM E 指定服务器节点名称。 取值：字符串形式，长度范围1~63，只能由字母、数字、句点(.)、下划线（）和短横线()组成，字母区分大小写，且仅支持以字母或数字开头。 默认使用服务器ID作为节点名称。 p PATH 或 path PATH 指定数据目录，支持多个数据目录，以英文逗号（,）隔开。 取值：只能包含字母、数字、汉字和特殊字符(~ ! @ $ ( ) + ; . :)。 注意 数据目录用于存储数据，建议不要与操作系统共用磁盘或文件系统。 capacityquota CAPACITYQUOTA 指定数据目录的容量配额，即针对加入到服务器中的每个数据目录，HBlock可写入的数据总量。当HBlock的使用空间一旦达到配额，就立刻阻止数据写入，不允许再使用超出配额的空间。 取值：整型。小于数据目录所在磁盘的总容量，单位是K/k、M/m、G/g、T/t、P/p，默认单位是G/g。负整数表示无限制写入，0表示禁止写入。默认不限制写入。 注意 如果一次添加多个数据目录，只能配置一个容量配额，配置的容量配额适用添加的所有目录。 portrange PORT1PORT2 指定端口范围。存储服务以及未指定端口的服务将从此范围中自动取值。 取值：整型，取值范围为[1, 65535]， PORT1 为端口范围最小值， PORT2 为端口范围最大值，且 PORT1 < PORT2 。 PORT1 默认取值为20000，PORT2默认取值为20500。 说明 建议指定的端口范围至少包含500个端口。 dataport1 DATAPORT1 数据端口1，整型，取值为[1, 65535]。 iscsiport ISCSIPORT iSCSI端口，整型，取值为[1, 65535]，默认端口为3260。 managementport1 MANAGEMENTPORT1 管理服务端口1，整型，取值为[1, 65535]。 managementport2 MANAGEMENTPORT2 管理服务端口2，整型，取值为[1, 65535]。 managementport3 MANAGEMENTPORT3 管理服务端口3，整型，取值为[1, 65535]。 managementport4 MANAGEMENTPORT4 管理服务端口4，整型，取值为[1, 65535]。 managementport5 MANAGEMENTPORT5 管理服务端口5，整型，取值为[1, 65535]。 managementport6 MANAGEMENTPORT6 管理服务端口6，整型，取值为[1, 65535]。

参数 描述 n NODENAME 或 name NODENAME 查询指定节点的拓扑图。 说明 不支持查询path节点。

本节主要介绍修改拓扑节点信息命令。 ./stor topology set { n name } NODENAME [ changedescription ] [ newname NEWNAME ] [ parentnode PARENTNODE ] 此命令用来修改拓扑节点信息。 注意 不支持修改path级别的节点信息。 参数 描述 : n NODENAME 或 nam e NODENAME 指定拓扑节点名称。 取值：字符串形式，长度范围1~63，只能由字母、数字、句点(.)、下划线（）和短横线()组成，字母区分大小写，且仅支持以字母或数字开头。 changedescription 修改拓扑节点的描述信息。 newname NEWNAME 指定拓扑节点的新名称。 取值：字符串形式，长度范围1~63，只能由字母、数字、句点(.)、下划线（）和短横线()组成，字母区分大小写，且仅支持以字母或数字开头。 parentnode PARENTNODE 修改拓扑节点的父节点。 示例 示例1 将节点hblock4的父节点修改为room3。 [root@hblockserver CTYUNHBlockPlus3.7.0x64] ./stor topology set name hblock4 parentnode room3 Set node hblock4 successfully. 示例2 修改节点room3的名称为room3。 [root@hblockserver CTYUNHBlockPlus3.7.0x64] ./stor topology set name room3 newname room3 Set node room3 successfully.

参数 描述 n NODENAME 或 name NODENAME 指定拓扑节点名称。 取值：字符串形式，长度范围1~63，只能由字母、数字、句点(.)、下划线（）和短横线()组成，字母区分大小写，且仅支持以字母或数字开头。 t NODETYPE 或 type NODETYPE 指定拓扑节点的类型。 取值： rack：机架类型。 room：机房类型。 parentnode PARENTNODE 指定父节点。 默认为根节点。

本节主要介绍添加节点到存储池的命令。 ./stor storagepool { A addnode } { n name } POOLNAME node NODE & 此命令用来添加节点到存储池。 说明 初始化时添加的数据目录节点都属于基础存储池节点。后续如果需要将基础存储池中的节点添加到其他存储池，需要先从基础储存池移除。 注意 待添加的节点必须属于集群拓扑节点，且每个集群拓扑节点只能添加到一个存储池中。 添加path级别的节点时，该path不能属于其他存储池，不能处在移除状态，path所属的服务器也不能处在移除状态。 当添加的节点类型低于存储池故障域级别，该节点的祖先节点中需要存在和该存储池故障域级别相同的映射节点，否则报错。如存储池故障域为rack，针对节点 root:room1:server1，将server1加入到该存储池时报错。 当添加的节点类型高于存储池故障域级别，该节点的子孙节点中需要存在和该存储池故障域级别相同的映射节点，否则报错。例如存储池故障域为rack，存在拓扑节点root:room1:server1:path1，将room1加入到该存储池时报错。 参数 参数 描述 :: n POOLNAME 或 name POOLNAME 指定存储池名称。 node NODE & 指定加入存储池的节点，该节点必须属于集群拓扑节点。一次可以添加多个节点至存储池，以英文逗号隔开。 说明 如果待添加的节点下含有子节点，则尚未被分配到任何存储池的子节点，将会被统一添加到该存储池中。 节点名称可以使用在集群拓扑中的全路径，格式为：name :name :name ，从根节点开始逐级指定；也可以使用部分路径，但该路径需在集群拓扑中唯一。例如default:room4:hblock4、room4:hblock4、hblock4在集群拓扑中均指向同一节点，且节点名在集群拓扑中唯一，则任选其一即可。

本节主要介绍添加服务器。 在“服务器管理”页面，点击“添加”，进入添加服务器页面，点击“添加服务器”，为集群添加服务器。 注意 待添加到集群的服务器安装HBlock后，才可以被添加。每次只能添加一台服务器至集群。 图1 添加服务器详情 图2 添加服务器 项目 描述 节点名称 指定服务器节点名称。 取值：字符串形式，长度范围1~63，只能由字母、数字、句点(.)、下划线（）和短横线()组成，字母区分大小写，且仅支持以字母或数字开头。 默认使用服务器ID作为节点名称。 父节点名称 指定父节点。 默认为根节点。 服务器IP 指定需要添加的服务器IP，支持IPv4和IPv6地址。 端口号 指定需要添加的服务器IP，支持IPv4和IPv6地址。 数据目录 服务器中，用于存储用户数据的绝对路径，一次可以添加多个数据目录，数据目录以英文逗号（,）分开。 取值：只能包含字母、数字、汉字和特殊字符(~ ! @ $ ( ) + ; . :)。 描述 节点描述。 取值：1~50位字符串。 容量配额 数据目录的容量配额，即给HBlock分配的容量配额。一旦达到配额，就立刻阻止数据写入。 支持输入数字（默认单位为GiB），或者输入“数字+单位”，数字应精确到两位小数，单位可为KiB、MiB、GiB、TiB或者PiB，并且配额需要不大于数据目录总容量，0表示禁止写入，负数或者不填表示无限制。 操作 点击“修改”，可以修改新增服务器信息。 添加服务器时，系统使用指定端口及端口范围进行服务初始化，如都未指定，则使用默认端口。如果需要修改，点击“此处”按钮即可修改新增服务器的端口。 图3 设置新服务器的端口 注意 请确保Linux用户具有所需要端口的权限。Linux系统默认小于1024的端口不对没有root权限的Linux普通用户开放。 设置端口范围时，请避免和Linux系统的本地临时端口（iplocalportrange）范围重合，否则可能会导致HBlock服务所用的端口被占用。使用命令行cat /proc/sys/net/ipv4/iplocalportrange可以查看本地临时端口范围。 参数 描述 端口范围 存储服务以及未指定端口的服务将从此范围中自动取值。 取值：整型，取值为[1, 65535]。默认取值为2000020500。 说明 建议指定的端口范围至少包含500个端口。 iSCSI服务 指定iSCSI端口号，默认端口号为3260。 数据服务 指定数据服务端口。 管理服务 指定管理服务端口号。

参数 描述 n LUNNAME 或 name LUNNAME 指定卷名称。可以指定一个或者多个卷，以英文逗号分开。 说明 如果不指定卷名称，表示设置所有卷。

本节主要介绍存储池列表信息。 点击导航栏中的“服务”>“存储池”，进入“存储池管理”页面。在“存储池管理”页面，可以查看存储池相关信息。可以通过“存储池名称”查找对应的存储池。 图1 存储池管理 项目 描述 存储池名称 存储池名称。 ：表示是基础存储池。 状态 存储池状态： 正常。 删除中。 故障域级别 存储池故障域级别： 数据目录级别。 服务器级别。 机架级别。 机房级别。 容量 存储池总容量。 缓存存储池卷 使用该存储池作为缓存存储池的卷。 存储池卷 使用该存储池作为存储池的卷。 卷存储模式：个数/容量 各种模式卷对应的个数及卷总容量。

名称 位置 类型 必选 说明 name query String 否 参数名称 pageNum query Integer 是 当前页,默认1 pageSize query Integer 是 页大小，默认10，最大限制500

接口描述 创建一个基础备份。 请求方法 POST URI /v1/backup/create 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id resId body Long 否 数据库资源唯一标识（不传默认使用主库,数据来源接口：/v1/resource/dbresource） backupName body String 否 备份名称 desc body String 否 备注 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 示例 请求示例 /v1/backup/createBackupJob { "prodInstId": 60, "resId": 1 } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labelIds body List 否 标签id列表,一次最多只能设置20个，unTagAllfalse时，该值必填 unTagAll body boolean 否 是否全部解绑，不传入labelIds才有效

错误码 访问ErrorCodes说明文档查看更多错误码。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存

接口描述 查询Postgresql实例本地日志列表 请求方法 GET URI /v1/monitor/instlog 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 logTime Long 日志时间 logFileName String 文件名称 prodInstId Long 实例id 示例 请求示例 /v1/monitor/listInstanceLog?prodInstId60 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ { "logFileName": "postgresql20220909103102.log", "logTime": 1662738918000, "prodInstId": 60 } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id

名称 二级节点 位置 类型 必选 说明 labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 是 标签列表,一次最多只能新增50个 labelName body String 是 资源标签名称，同一租户下标签名称唯一、平台标签名称唯一 labelValue body String 否 标签值 remark body String 否 标签说明

接口描述 修改SQL洞察日志保存时长。 接口约束 实例需要已开启SQL洞察 URI PUT /v1/collector/sqlcollectorretention 请求参数 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 retainValue 是 Integer SQL洞察日志保存时长，单位：天，取值：30，180，365，1095，1825 30 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 请求示例 /v1/collector/sqlcollectorretention 请求体body { "prodInstId": 10, "retainValue": 30 } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array resId Integer 数据库资源唯一标识 databaseName String 数据库名称 querySql String 查询的语句 userName String 用户名 clientAddress String 客户端ip clientPort Integer 客户端端口 queryStart String 查询开始时间 queryEnd String 查询结束时间 queryPlan String 查询计划 queryCost Integer 耗时，单位:ms

接口描述 查询PostgreSQL实例支持的字符集 请求方法 GET URI /v1/database/charactersetname 请求参数 名称 位置 类型 必选 说明 engine query String 是 数据库引擎类型。取值： postgreSQL：PostgreSQL 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 characterSetNameItems List 支持的字符集列表,例如： ["gbk","utf8","ascii"] engine String 数据库引擎类型。取值： postgreSQL：PostgreSQL 示例 请求示例 /v1/database/getCharacterSetName?enginepostgreSQL 响应示例 { "message": "SUCCESS", "returnObj": { "characterSetNameItems": [ "utf8", "gbk", "ascii" ], "engine": "postgreSQL" }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 查询RDS实例的SQL洞察（SQL审计）日志 接口约束 URI GET /v1/collector/sqllogrecords 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 pageNum 是 Integer 页码最小值为1 1 pageSize 是 Integer 页大小取值范围为：1500 10 dbName 否 String 数据库名称。默认为所有数据库，也可以输入数据库名称查询，一次只能输入一个 test accountName 否 String 用户名称。默认为所有用户，也可以输入用户名称查询，一次只能输入一个 root startTime 是 String 查询开始时间,格式：yyyyMMdd HH:mm:ss endTime 是 String 查询结束时间,大于查询开始时间，与查询开始时间间隔小于等于30天,格式：yyyyMMdd HH:mm:ss queryKeywords 否 List 用于查询的关键字,​ 1.多个关键字以空格分隔，不超过10个关键字​ 2.如果SQL语句中的字段名使用了反引号（），以该字段名作为查询的关键字时，也需要输入反引号。例如，字段名为id，则输入id，而不是id SELECT 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj PageVO 返回对象 PageVO 参数 参数类型 说明 示例 下级对象 pageNum Integer 页码 1 pageSize Integer 页大小 10 pageTotal Integer 总页数 1 total Integer 总记录数 2 list List 记录 DescribeSQLLogRecordsVO DescribeSQLLogRecordsVO 参数 参数类型 说明 示例 下级对象 hostAddress String 连接数据库的客户端IP地址 192.168.0.18:50744 sqlText String SQL语句 terminating connection due to administrator command dbName String 数据库名称 postgres executeTime Long 执行时间 1667354445000 threadId String 线程id 6952 accountName String 执行操作的账号名称 test

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 prodInstId Long 实例id dbName String 数据库名称 dbEncoding String 字符集 dbCollate String 字符串排序规则 dbCtype String 字符分类 dbOwner String 数据库所有者 createTimestamp Long 创建时间 updateTimestamp Long 更新时间 dbDescription String 数据库描述

接口功能介绍 修改实例的root账户密码 接口约束 实例必须处于运行中的状态 URI PUT /v1/remote/rootpassword 请求参数 body参数 参数 是否必填 参数类型 说明 示例 prodInstId 是 Integer 实例id 54 newPassword 是 String 新密码。816位，且必须含有数字，小写字母，大写字母，特殊字符 Arcyd12EQR 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] 请求示例 /v1/remote/rootpassword 请求参数 json { "prodInstId":54, "newPassword":"Arcyd12EQR" } 响应示例 json { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 示例 请求示例 {URI}?/v1/instuser/hbaconfig { "prodInstId":34, "opType":"modify", "line":10, "items":{ "type":"host", "username":"test,usertest", "database":"test,test2" } } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array recoveryEndTime Long 备份可恢复的终止时间 recoveryBeginTime Long 备份可恢复的起始时间 prodInstId Long 实例id backupId Long 备份id backupName String 备份名称

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] VpcForm

接口描述 查询SQL洞察（SQL审计）状态。 实例必须为运行状态. 请求方法 GET URI /v1/collector/sqlcollectorpolicy 请求参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 List DescribeSQLCollectorPolicyVO 参数 参数类型 说明 示例 下级对象 host String 数据库ip 192.168.1.11 port Integer 数据库端口 5432 sqlCollectorStatus String SQL审计状态，取值：enable disabled disabled 示例 请求示例 /v1/collector/sqlcollectorpolicy?prodInstId10 响应示例 { "message": "SUCCESS", "returnObj": [ { "host": "192.168.1.11", "port": 5200, "sqlCollectorStatus": "disabled" }, { "host": "192.168.1.12", "port": 5200, "sqlCollectorStatus": "disabled" } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存