-
响应示例 {
"data": [
{
"orgId": 502,
"orgNo": "01",
"orgName": "save",
"orgPath": "-1",
"parentOrgId": 0,
"children": [
{
"orgId": 101788,
"orgNo": "test1",
"orgName": "test1",
"orgPath": "-1.502",
"parentOrgId": 502
}
]
}
],
"pos": 0,
"totalCount": 1,
"entityName": "org"
}
-
响应示例 {
"status": "success",
"msg": "200",
"data": [
{
"safetyRegulationsClausesId": "1111",
"safetyRegulationsClausesPart": "编",
"safetyRegulationsClausesChapter": "章",
"safetyRegulationsClausesSectioned": "节",
"safetyRegulationsClausesArticle": "条",
"safetyRegulationsClausesDesc": "hzjTest1"
},
{
"safetyRegulationsClausesId": "章节条款id",
"safetyRegulationsClausesPart": "编",
"safetyRegulationsClausesChapter": "章",
"safetyRegulationsClausesSectioned": "节",
"safetyRegulationsClausesArticle": "条",
"safetyRegulationsClausesDesc": "内容描述"
}
],
"failed": false,
"success": true
}
-
快速部署 本章节主要帮助用户快速部署该解决方案 表1 参数说明 参数名称 类型 是否必填 参数解释 默认值 tidb_version string 是 TiDB版本,支持v7.1.1及v8.1.2。 v8.1.2 enterprise_project_id string 是 企业项目id,请参考部署指南到项目管理界面获取https://console.huaweicloud.com/eps/,0代表default项目。 0 vpc_name string 是 虚拟私有云 VPC名称,该模板新建VPC,不允许重名。取值范围:1-54个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 high-availability-tidb security_group_name string 是 安全组名称,该模板新建安全组。取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 high-availability-tidb ecs_name string 是 弹性云服务器 E
CS 名称前缀,不允许重名。命名规则{ecs_name}-tidb0X、{ecs_name}-tiflash、{ecs_name}-pd0X及{ecs_name}-tikv0X、{ecs_name}-monitor,其中X取值[1,3]。取值范围:1-54个字符,支持数字、字母、_(下划线)、-(中划线)、.(点)。 high-availability-tidb ecs_password string 是 ECS初始化密码及Console运维平台初始化密码,请参考重置ECS实例密码登录ECS控制台修改密码。取值范围:长度为8-26位,密码至少必须包含大写字母、小写字母、数字和特殊字符!@%?*#.中的三种,密码不能包含用户名或用户名的逆序。管理员账户为root。 无 tidb_flavor string 是 TiDB-ECS规格,推荐使用16vCPUs32GB及以上规格。具体规格请参考官网弹性云服务器规格清单。 c7.4xlarge.2 pd_flavor string 是 PD-ECS规格,推荐使用4vCPUs8GB及以上规格。具体规格请参考官网弹性云服务器规格清单。 c7.xlarge.2 tikv_flavor string 是 TiKV-ECS规格,推荐使用16vCPUs32GB及以上规格。具体规格请参考官网弹性云服务器规格清单。 c7.4xlarge.2 tiflash_flavor string 是 TiFlash-ECS规格,推荐使用32vCPUs64GB及以上规格。具体规格请参考官网弹性云服务器规格清单。 c7.8xlarge.2 monitor_flavor string 是 Monitor&Grafana-ECS规格,推荐使用4vCPUs8GB及以上规格。具体规格请参考官网弹性云服务器规格清单。 c7.xlarge.2 ecs_disk_size number 是 各组件系统盘大小,磁盘类型默认通用型SSD,以GB为单位,取值范围为40-1,024,不支持缩盘。 100 tiflash_disk_size number 是 TiFlash数据盘大小,磁盘类型默认通用型SSD,以GB为单位,取值范围为10-32,768,不支持缩盘。 2048 tikv_disk_size number 是 TiKV数据盘大小,磁盘类型默认通用型SSD,以GB为单位,取值范围为10-32,768,不支持缩盘。 2048 monitor_disk_size number 是 Monitor&Grafana数据盘大小,磁盘类型默认通用型SSD,以GB为单位,取值范围为10-32,768,不支持缩盘。 500 elb_name string 是 弹性负载均衡,用于访问TiDB 输入为ELB名称前缀,命名规则{elb_name}_elb。取值范围:1-51个字符组成,支持中文、英文字母、数字、_(下划线)、-(中划线)、.(点)。 high-availability-tidb charge_mode string 是 计费模式,默认自动扣费,可选值为:postPaid(按需计费)、prePaid(包年包月)。 postPaid charge_period_unit string 是 订购周期类型,仅当charge_mode为prePaid(包年/包月)生效。取值范围:month(月),year(年)。 month charge_period number 是 订购周期,仅当charge_mode为prePaid(包年/包月)生效。取值范围:charge_period_unit=month(周期类型为月)时,取值为1-9;charge_period_unit=year(周期类型为年)时,取值为1-3。 1 登录华为云解决方案实践,选择“快速构建高可用TiDB集群”,单击“一键部署”,跳转至解决方案创建资源栈界面。 图1 解决方案实践 在选择模板界面中,单击“下一步”。 图2 选择模板 在配置参数界面中,参考表3-1 参数填写说明完成自定义参数填写,单击“下一步”。 图3 配置参数 (可选,如果使用华为主账号或admin用户组下的
IAM 子账户可不选委托)在资源设置界面中,在权限委托下拉框中选择“rf_admin_trust”委托,单击“下一步”。 图4 资源栈设置 在配置确认界面中,单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中,自定义填写执行计划名称,单击“确定”。 图6 创建执行计划 单击“部署”,并且在弹出的执行计划确认框中单击“执行”。 图7 执行计划 图8 执行计划确认 (可选)如果计费模式选择“包年包月”,在余额不充足的情况下(所需总费用请参考2-表 资源和成本规划(包年包月))请及时登录费用中心,手动完成待支付订单的费用支付。 待“事件”中出现“Apply required resource success”,表示该解决方案资源已经部署完成,后台将自动完成环境构建。 图9 部署完成 父主题: 实施步骤
-
响应示例 状态码: 200 成功响应示例 {
"schema_count" : 2,
"schema_list" : [ {
"start_time" : "2022-01-21T10:13:31",
"last_update_time" : "2022-01-21T10:13:31",
"name" : "schema_748e",
"description" : "xxxxx",
"id" : "6634c50e-13aa-4395-8088-6b327f7da694",
"metadata_path" : "devdata/schema_748e.xml",
"status" : "200"
}, {
"start_time" : "2022-04-12T03:15:17",
"last_update_time" : "2022-11-16T08:18:32",
"name" : "unionsdk_schema",
"id" : "6b74069d-3cf3-4cc0-9118-2478e23b87aa",
"metadata_path" : "devdata/unionsdk/unionsdk_schema.xml",
"status" : "200"
} ]
} 状态码: 400 失败响应示例 {
"error_code" : "GES.7006",
"error_msg" : "An internal error occurs in the underlying service of the graph engine."
}
-
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 schema_count Integer 元数据返回个数。请求失败时,字段为空。 schema_list Array of schema_list objects 当前project_id下的所有元数据列表。请求失败时,字段为空。 表5 schema_list 参数 参数类型 描述 id String 元数据 ID。 name String 元数据名称。 start_time String 元数据创建时间。 last_update_time String 元数据最后更新时间。 description String 元数据描述。 metadata_path String 元数据对应路径。 status String 元数据是否可用。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
-
开始使用 有关TiDB详细使用指导请参考TiDB产品文档。 该解决方案涉及到的TiDB组件端口默认不开放,实际使用中请参考修改安全组规则,配置IP地址白名单,以便能正常访问服务,使用默认配置部署的TiDB全部组件端口表请参考TiDB端口说明。 后续文档将展开TiDB的基础使用与集群监控,请预先配置如下端口的安全组规则: 1、22端口:用于登录Monitor节点,以查看集群的部署状态 2、2379端口:用于接入PD组件部署的集群仪表盘 3、3000端口:用于接入Monitor节点承载的Grafana监控服务 4、4000端口:应用及 DBA 工具访问通信端口,用于接入TiDB集群 安全组规则修改(可选) 安全组实际是网络流量访问策略,包括网络流量入方向规则和出方向规则,通过这些规则为安全组内具有相同保护需求并且相互信任的云服务器、云容器、云数据库等实例提供安全保护。 如果您的实例关联的安全组策略无法满足使用需求,比如需要添加、修改、删除某个TCP端口,请参考以下内容进行修改。 添加安全组规则:根据业务使用需求需要开放某个TCP端口,请参考添加安全组规则添加入方向规则,打开指定的TCP端口。 修改安全组规则:安全组规则设置不当会造成严重的安全隐患。您可以参考修改安全组规则,来修改安全组中不合理的规则,保证云服务器等实例的网络安全。 删除安全组规则:当安全组规则入方向、出方向源地址/目的地址有变化时,或者不需要开放某个端口时,您可以参考删除安全组规则进行安全组规则删除。 登录华为云弹性云服务器控制台,查看ECS是否正常创建,并查看Monitor节点的公网IP地址。 图1 查看ECS资源以及Monitor节点的公网 (图中ECS规格仅为示例使用,具体规格以实际填写为准。) 远程连接Monitor节点 ECS创建完成后,后台会进行环境部署,等待约15分钟后,可使用SSH连接工具或通过ECS控制台远程连接Monitor节点以进行后续集群状态查看(请确保22端口安全组已开放)。 图2 远程连接Monitor节点 查看部署进度与集群状态 使用命令"cat /tmp/tidb_monitor_htap.log"查看部署日志,在行末见到如下图集群启动成功日志即为部署成功 图3 集群启动成功日志 使用命令"tiup cluster display tidb"查看部署集群状态,状态为Up即为节点状态正常。记录状态为UI的pd节点的私网IP地址。如下图所示。 图4 查看集群状态 返回弹性云服务器控制台,根据私网IP搜索目标pd节点,如下图所示。 图5 承载UI仪表盘的pd节点 进入该ECS的详情页,单击弹性公网IP的标签栏。单击"绑定弹性公网IP",选择由模板创建的弹性公网IP,如下图所示。(如果无如图命名的弹性公网IP,请查看弹性公网IP是否被其它业务节点占用,请进行解绑与重新绑定)。 图6 pd节点详情页 图7 绑定弹性公网IP 确保安全组(2379端口)已配置的前提下,访问地址:{上述弹性公网IP}:2379/dashboard,登录TiDB Dashboard以查看集群内组件使用状态(用户名为root 密码为空) 图8 TiDB Dashboard登录页 图9 查看集群内各组件状态 访问TiDB计算节点 登录弹性负载均衡ELB服务控制台,查看模板创建出的ELB的公网地址,如下图所示。确保安全组(端口4000)已配置的前提下,可使用linux命令"mysql --host {ELB公网地址} --port 4000 -u root"接入数据库。(即数据库IP为ELB的公网地址,接入端口为4000,用户名为root,密码为空) 图10 绑定TiDB计算节点的ELB 图11 接入TiDB 访问Grafana仪表盘 确保安全组(端口3000)已配置的前提下,访问{Monitor节点弹性公网IP}:3000即可访问Grafana仪表盘(用户名为admin,密码为admin)。重置密码后即可进入Grafana控制台,如下图所示。 图12 Grafana主页 图13 重置密码 图14 Grafana控制台 父主题: 实施步骤
-
创建rf_admin_trust委托(可选) 进入华为云官网,打开控制台管理界面,鼠标移动至个人账号处,打开“
统一身份认证 ”菜单。 图1 控制台管理界面 图2 统一身份认证菜单 进入“委托”菜单,搜索“rf_admin_trust”委托。 图3 委托列表 如果委托存在,则不用执行接下来的创建委托的步骤。 如果委托不存在时执行接下来的步骤创建委托。 单击步骤2界面中的“创建委托”按钮,在委托名称中输入“rf_admin_trust”,委托类型选择“云服务”,选择“
RFS ”,单击“下一步”。 图4 创建委托 在搜索框中输入“Tenant Administrator”权限,并勾选搜索结果,单击“下一步”。 图5 选择策略 选择“所有资源”,并单击下一步完成配置。 图6 设置授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功。 图7 委托列表
-
数据管理流程 数据管理功能可以协助用户快速建立数据模型,为后续的脚本和作业开发提供数据实体。通过数据管理,您可以: 支持管理DWS、
MRS Hive、
DLI 等多种
数据湖 。 支持可视化和DDL方式管理数据库表。 注意,在MRS API连接方式下,不支持通过可视化方式查看与管理该连接下的数据库、数据表和字段。 单击可以查看数据连接目录树下的数据库、数据表以及字段信息。DWS SQL、DLI SQL、MRS Hive SQL代理模式均支持查看目录树,其他数据连接均不支持。 如果您在使用数据开发前,已创建了数据连接和对应的数据库和数据表,则可跳过数据管理操作,直接进入脚本开发或作业开发。 数据管理的使用流程如下: 图1 数据管理流程 创建数据连接,连接相关数据湖底座服务。具体请参见新建数据连接。 基于相应服务,新建数据库。具体请参见新建数据库。 如果是DWS连接,则需要新建数据库模式;否则直接新建数据表。具体请参见(可选)新建数据库模式。 新建数据表。具体请参见新建数据表。 父主题: 数据管理
-
数据审计 平台通过
云审计 服务(
CTS )提供操作记录的收集、存储和查询,审计操作可以设置导出用户的写操作(默认)和读操作(可选),保存周期可以设置需要保存的审计日志的保存周期,下载按钮可以下载最近7天内最新的1万条数据审计日志,查看按钮可以查看及下载保存的审计日志。 通过审计日志可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。您可以在项目的“设置”页面下载最近7天的数据审计日志,其他操作的审计日志请登录云审计服务控制台查看。 图2 数据审计
-
恢复数据 平台支持数据的恢复机制,您可以将归档的核心数据进行恢复,避免造成损失。 数据归档成功后,可以在“归档”页面查看归档记录,并进行恢复、删除操作。归档恢复时,您可以将数据恢复至本项目或有权限的其他项目。 数据归档成功后,选择“归档”页签。 图10 选择归档页签 选择需要恢复的数据,单击操作列“恢复”。在恢复归档数据页面,选择需要恢复数据的位置和数据。 图11 选择恢复数据的位置 单击“确定”。
-
禁止/允许删除数据 您可以对某个数据设置禁止删除。设置禁止删除后,该目录只能添加数据,不支持删除数据。也可以通过“允许删除”取消禁止删除设置。 图7 开启禁止删除数据 支持设置最多15个数据的禁止删除状态。 如果平台或者父目录设置禁止删除状态,则对应的数据根路径或者子路径均为禁止删除状态,子路径不支持同时设置允许删除状态;如果平台或者父目录设置允许删除,则之前子路径设置的禁止删除权限失效,全部子路径允许删除。
-
命令示例 本节以Windows为例介绍eihealth-toolkit的使用过程,Linux和macOS环境使用方法基本相同,可参考。 假设“lmx-test-01”项目引用了来自“lmx-test-02”项目的数据,使用health switch project lmx-test-01命令进入“lmx-test-01”项目,使用health ls命令列举该项目下的对象。 指定“path”参数为根目录,查询根目录下所有对象。 health ls / -r
# 返回结果如下
# *表示引用的其他项目中的数据
*lmx-test-02:/test1.txt
*lmx-test-02:/test2.txt
*lmx-test-02:/src1/
*lmx-test-02:/src1/test1.txt
# Folder list为本项目中的数据
Folder list:
/src1/
/src2/
File list:
key size last_Modified
/test1.txt 6.57MB 2020/11/09 10:32:12
/test2.txt 6.57MB 2020/11/09 10:32:12
/test3.txt 6.57MB 2020/11/09 10:32:12
/test4.txt 6.57MB 2020/11/09 10:32:12
/test5.txt 6.57MB 2020/11/09 10:32:12
/test6.txt 6.57MB 2020/11/09 10:32:12
/src1/test7.txt 6.57MB 2020/11/09 10:32:12
/src2/test8.txt 6.57MB 2020/11/09 10:32:12
Total size of current file is: 52.56MB
Folder number is: 4
File number is: 8 指定“limit”参数,并只列举项目中的3个对象。 health ls --limit 3
# 返回结果如下
Folder list:
/src1/
/src2/
File list:
key Size LastModified
/test1.txt 6.57MB 2020/11/09 10:32:12
Total size of current file is: 6.57MB
Folder number is: 2
File number is: 1 指定“path”参数,列举某指定路径中的对象。 health ls /src2/ # 列举路径中的文件夹对象时,需使用/xxx/格式
# 返回结果如下
Folder list:
/src2/ # 路径中无文件夹时,返回为空
File list:
key Size LastModified
/src2/test8.txt 6.57MB 2020/11/09 10:32:12
Total size of current file is: 6.57MB
Folder number is: 1
File number is: 1 指定“simple”参数,以简略格式显示对象。 health ls --simple
# 返回结果如下
Folder list:
/src1/
/src2/
File list:
/test1.txt
/test2.txt
/test3.txt
/test4.txt
/test5.txt
/test6.txt
/src1/test7.txt
/src2/test8.txt
Total size of current file is: 52.56MB
Folder number is: 2
File number is: 8 指定引用项目。 health ls lmx-test-02:/src1/ --simple
Start at 2022-08-23 08:28:43.3699574 +0000 UTC
Listing objects .
Folder list:
Object list:
/src1/test1.txt
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,
获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 paths 是 Array of strings 删除的数据ID集(项目名称:/路径) 最小长度:1 最大长度:2000 数组长度:0 - 50
-
URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
-
URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/policy 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128