华为云用户手册

责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的 IaaS、PaaS 和 SaaS 各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。 华为云租户的安全责任在于对使用的 IaaS、PaaS 和 SaaS 类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API 网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题： 安全

简单易用的编排语言 AOS编排语言支持 YAML和JSON 语法来定义需要的元素。 AOS编排语言支持参数化，您只需更改输入参数，即可控制要部署对象的规格、实例数量以及执行的操作，从而实现模板的重复利用。 AOS编排语言支持变量引用，包括引用输入参数、引用元素属性和引用映射表。 引用输入参数：获取模板文件中inputs区域中定义的输入参数的值。 引用元素属性：获取模板中定义的其他元素初始化后的结果。例如新建了一个虚拟私有云，再新建弹性云服务器时，可使用已新建的虚拟私有云ID。该方法可用于构建资源间依赖关系并控制资源的创建顺序。 引用映射表：用于获取映射表中的内容。

ISV资源发放 场景描述 独立软件开发商(ISV)需要快速将软件所需资源部署到云上，供其众多的客户进行使用。传统的软件发放的方式是在其官网提供软件的代码下载及平台搭建指南。但该方式需要ISV自行组网、交付资源、部署软件，准备时间长，成本高。 解决方案 资源编排提供了标准化的资源和应用交付方式。ISV可以通过将软件服务模板化。通过资源编排的资源栈部署能力，对自身客户进行快速业务发放，将交付过程流程化。资源编排使用代码形式模板描述整个交付环境，也便于ISV将交付与CI/CD流程集成。 收益优势： 交付标准化 通过模板、资源栈方式将软件交付过程标准化，便于总结成最佳实践以便推广。 提升效率 通过模板，自动化完成资源的开通，ISV只需部署资源栈，即可完成业务的交付；提升了ISV的交付效率。 准确创建 ISV的软件本身及所需的云服务资源都通过模板固化，减少人工失误带来的影响。 CI/CD集成 可以将资源编排集成到现有工具链中，提升自动化程度。 图2 ISV资源发放场景

应用上云 场景描述 应用上云时，很多工作需要手工重复操作，例如环境的销毁和重建、在扩容的场景下重复完成多个新实例的配置等，手工操作容易带来操作失误。 同时应用上云时，很多操作非常耗时，例如创建数据库、创建虚拟机等，手动操作容易失误 ，串行创建多个任务，就需要您持续等待较长时间。 解决方案 资源编排就是将上述场景的工作进行工具化、流程化。资源编排采用模板对应用所需资源进行统一描述；资源栈管理功能提供众多资源自动化部署或销毁操作。资源编排可以将大批量、不同服务、不同规格的资源实例，统一定义在模板中。完成自动化创建，实现资源的快速部署和灵活配置。 收益优势 简单易用 通过编写模板，即可完成应用设计与资源的规划，使业务的组织和管理变得轻松。 高效执行 向导式自动完成部署或销毁操作，省去繁琐的人工操作，减少了人为操作的失误 。 快速复制 同一模板可以多次重复使用，自动化构建相同的应用与资源到不同的数据中心。提升了您的工作效率。

审计与日志 审计 云审计服务（Cloud Trace Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 AOS支持审计的操作事件，请参见云审计服务支持的AOS操作列表。 日志 用户开通云审计服务并创建和配置追踪器后，CTS可记录与AOS相关的操作事件，方便您进行事后审计。您可以在CTS控制台，事件列表菜单中，搜索AOS的事件来源，即可查看所有AOS相关的审计日志。 审计日志查看方法，请参见查看云审计日志。 父主题： 安全

支持Provider版本列表 支持Provider版本列表 Provider是将各类资源的API（比如资源的CRUD操作API）封装而成的插件，供资源编排引擎调用。资源编排支持Provider类型与版本如下表。 类型 版本 terraform-provider-huaweicloud 1.40.2 1.40.1 1.40.0 1.39.0 1.38.2 1.38.1 terraform-provider-kubernetes 2.5.0 父主题： 资源编排

操作步骤 登录SAP S/4HANA主节点，获取ha_auto_script.zip压缩包，解压到任意目录。 选择安装SAP S/4HANA所在的Region，下载脚本， 此处以“华北-北京四”为例： wget https://obs-sap-cn-north-4.obs.cn-north-4.myhuaweicloud.com/ha_auto_script/ha_auto_script.zip -P /sapcd 不同Region对应的脚本下载地址如下： 华北-北京一：https://obs-sap-cn-north-1.obs.cn-north-1.myhuaweicloud.com/ha_auto_script/ha_auto_script.zip 华北-北京四：https://obs-sap-cn-north-4.obs.cn-north-4.myhuaweicloud.com/ha_auto_script/ha_auto_script.zip 华东-上海二：https://obs-sap.obs.cn-east-2.myhuaweicloud.com/ha_auto_script/ha_auto_script.zip 华南-广州：https://obs-sap-cn-south-1.obs.cn-south-1.myhuaweicloud.com/ha_auto_script/ha_auto_script.zip 执行以下命令，解压文件。 cd /sapcd unzip ha_auto_script.zip 根据客户实际情况配置ascs_ha.cfg文件中的参数。各参数含义如表1所示。 表1 ascs_ha.cfg配置文件参数含义 参数类型 参数名称 参数解释 masterNode masterName ASCS实例节点的主机名 masterHeartbeatIP1 ASCS实例节点心跳平面IP1 masterHeartbeatIP2 ASCS实例节点业务平面IP slaveNode slaveName ERS实例节点的主机名 slaveHeartbeatIP1 ERS实例节点心跳平面IP1 slaveHeartbeatIP2 ERS实例节点业务平面IP ASCSInstance ASCSFloatIP ASCS实例的业务IP ASCSInstanceDir ASCS实例的目录 ASCSDevice ASCS实例目录所使用的磁盘分区 ASCSProfile ASCS实例的profile文件 ERSInstance 说明： ERSInstanceDir、ERSDevice和ERSProfile参数信息需要登录ERS实例节点获取。 ERSFloatIP ERS实例的业务IP ERSInstanceDir ERS实例的目录 ERSDevice ERS实例目录所使用的磁盘分区 ERSProfile ERS实例的profile文件 trunkInfo SBDDevice SBD使用独立磁盘，支持1个或3个，多个磁盘之间使用英文逗号分隔，如/dev/sda, /dev/sdb, /dev/sdc 执行脚本进行HA自动部署。 sh ascs_auto_ha.sh 执行以下命令，查看资源状态。 crm status HA功能配置完成后，HAE会管理资源，请不要使用其他方式启动或停止资源。如果需要手动执行一些测试或者修改操作，请先将集群进入维护模式。 crm configure property maintenance-mode=true 修改完成后再退出维护模式。 crm configure property maintenance-mode=false 如果需要对节点进行关机或者重启等操作，请先手动关闭集群服务。 systemctl stop pacemaker 虚拟机启动或者重启完成后，需要手动执行以下命令来启动集群服务。 systemctl start pacemaker 如需清除HA功能配置，请在主节点（此处为在配置HA功能时的主节点，若已发生主备切换请先恢复到初始状态）手动执行以下命令。 sh ascs_auto_ha.sh unconf

SID或租户名改变 1. 若新系统和原系统不在一个区域时，需先通过OBS跨区域复制功能，将原系统的备份，复制到新系统所在的区域，再进行后续操作。 2. 在新系统中安装并配置Backint。 3. 根据需要，参考恢复选择对应的恢复类型进行恢复，同时需勾选系统拷贝，并指定原系统的SID。注意：原系统为多租户时，需同时指定租户名和SID，写法为{tenant name}@{SID}。下图以"Recover the database to its most recent state"为例，选择“Search for the backup catalog in Backint only”，Source System为“S02@S03”。 父主题： 恢复到新系统

华为云CDN将调整状态码400的缓存逻辑 华为云CDN将于北京时间2024/06/07 00:00（北京时间）修改状态码400的缓存逻辑，由之前的默认缓存3s调整为默认不缓存，新逻辑生效后的影响如下： 如果您的域名之前从未修改状态码400的缓存逻辑，则后续执行新的缓存逻辑，不缓存400状态码。 如果您的域名之前修改过状态码400的缓存逻辑，则遵循您设置的缓存时间。示例：域名www.example.com修改了状态码400的缓存时间为10s，新的缓存逻辑上线后该域名状态码400的缓存时间依然是10s。 如果您需要修改状态码缓存时间，请参考这里。

什么是连接，怎样创建连接？ 什么是连接？ 连接是用来保存连接器的各种认证信息，配置了连接后，才可正常使用连接器。 由于连接器中的接口API调用时所需要的认证方式都是统一的，故可以将认证鉴权所需参数提取成“连接”的形式统一管理。用户调用接口时所需要的认证鉴权信息都会在连接中获取到。在定义接口的参数时，用户只需要关心业务相关的参数，如果涉及认证鉴权信息的参数，可以不写。 怎样创建连接？ 创建连接的操作请参考连接管理。 父主题： 连接器管理

修订记录 发布日期 修订记录 2024-06-03 第十九次正式发布。 优化如下章节： 什么是连接，怎样创建连接？ 如何快速找到自己想要的卡片模板？ 2024-05-30 第十八次正式发布。 修改如下章节： 模型采集支持采集的数据源类型有哪些？ 删除如下章节： 为什么发布业务模型后在模型地图中检索不到对应资产？ 2024-04-24 第十七次正式发布。 删除如下章节： 计费管理及其子章节 退订服务及其子章节 2024-04-19 第十六次正式发布。 修改如下章节： 创建连接器时，验证方式该如何选择？ 如何进行连接器执行动作的测试？ 连接器支持哪些身份验证类型？ 如何创建并使用函数？ 2024-03-11 第十五次正式发布。 修改如下章节： 如何创建并使用函数？ 什么是连接，怎样创建连接？ 如何快速构建卡片？ 2024-01-31 第十四次正式发布。 优化如何快速构建卡片？章节。 2023-11-16 第十三次正式发布。 优化“为什么没有使用集成工作台，却产生了费用？”章节。 2023-08-18 第十二次正式发布。 优化什么是连接，怎样创建连接？章节。 2023-08-08 第十一次正式发布。 优化如何创建并使用函数？章节。 2023-05-11 第十次正式发布： 新增如下章节： 应用模型 什么是信息架构？ 模型目录能干什么？ 模型采集支持采集的数据源类型有哪些？ 为什么发布业务模型后在模型地图中检索不到对应资产？ 为什么采集到的技术模型在模型地图中检索不到？ 在数据源内容更新时，如何在应用模型中刷新对应数据？ 为什么在创建数据源时测试连接会失败？ 2023-04-27 第九次正式发布。 新增如下章节： 包年/包月和按需计费模式有什么区别？ 包年/包月和按需计费模式是否支持互相切换？ 为什么没有使用集成工作台，却产生了费用？ 优化如下章节： 能否共享创建的流？ 2023-04-07 第八次正式发布。 新增如下章节： 业务可视化 业务可视化支持哪些浏览器？ 什么是卡片？ 如何快速构建卡片？ 如何快速找到自己想要的卡片模板？ 构建好的卡片被误删了怎么办？ 2023-3-31 第七次正式发布。 优化如下章节： 能否共享创建的流？ 2023-01-18 第六次正式发布。 新增如下章节： 如何在流中自助定位问题 如何创建并使用函数 2022-12-14 第五次正式发布。 新增“退订服务”章节。 2022-11-30 第四次正式发布。 新增“计费管理”章节。 优化如下章节： 能否共享创建的流 什么是连接，怎样创建连接 如何进行连接器执行动作的测试 企业管理员与系统集成商，拥有的权限有什么不同 2022-11-01 第三次正式发布。 优化如下章节： 什么是连接，怎样创建连接 2022-09-29 第二次正式发布。 新增如下章节： 函数 API生命周期 Astro轻应用 2022-04-30 第一次正式发布。

修订记录 发布日期 修订记录 2024-06-03 第三十二次正式发布。 修改如下章节： 共享流模板 从空白开始创建流 使用流模板创建流 发布为模板 配置管理 连接管理 API流（简易版） 新增覆盖流章节。 2024-05-30 第三十一次正式发布。 新增如下章节： 导出实体元模型 修改如下章节： 应用模型使用流程 实例管理 检索模型 创建实体元模型 接入SFTP数据源 接入本地文件数据源 创建业务架构 创建技术架构 消息中心 模型目录（新版） 模型采集 2024-04-19 第三十次正式发布。 修改如下章节： 创建连接器 创建执行动作 新增如下章节。 变量V2 数据格式转换 生成器 IoT数据分析 人像动漫化渲染 百度地图 高德地图 快手 国家预警信息 停车场查询 拼多多 佐糖图片修复 铁路出行 行业模板介绍 2024-04-09 第二十九次正式发布。 修改如下章节： 使用在线构建新建卡片 新建卡片模板 2024-03-18 第二十八次正式发布。 修改如下章节： 使用在线构建新建卡片 新建卡片模板 2024-03-13 第二十七次正式发布。 修改如下章节： 开通并购买MSSI服务 实例管理 2024-03-11 第二十六次正式发布。 修改如下章节： 从空白开始创建流 创建函数 控制 华为短信（体验） 2024-02-08 第二十五次正式发布。 修改如下章节： 从空白开始创建流 发布为模板 连接管理 优化业务可视化全部子章节。 2024-01-09 第二十四次正式发布。 修改如下章节： 使用模板构建新建屏幕 使用离线构建新建屏幕 使用在线构建新建卡片 新建卡片模板 创建业务架构 创建技术架构 检索模型（新版） 检索模型（旧版） 通道注册 事件订阅 新增如下章节： 华为云数字工厂 复制业务架构 复制技术架构 实例管理 概览 2023-12-06 第二十三次正式发布。 修改如下章节： 从空白开始创建流 配置管理 创建连接器 控制 使用在线构建新建卡片 新建屏幕模板 新建卡片模板 查询审计事件 2023-11-10 第二十二次正式发布。 新增如下章节： 我的卡片界面介绍 使用卡片模板新建卡片 公共屏幕模板界面介绍 公共卡片模板界面介绍 优化如下章节： 内置函数 使用在线构建新建卡片 使用离线构建新建卡片 管理卡片 新建卡片模板 如何查看审计日志 2023-11-01 第二十一次正式发布。 新增如下章节： API流（简易版） 配置标注 数据集添加血缘关系 添加标注 添加业务字典 信息架构 业务术语 优化如下章节： 共享流模板 从空白开始创建流 查看流详情 创建连接器 API生命周期 接入数据源 删除如下章节： 发布业务资产 2023-10-19 第二十次正式发布。 优化如下章节： 业务可视化概述 使用模板构建新建屏幕 使用离线构建新建屏幕 我的屏幕轮播 使用在线构建新建卡片 新建屏幕模板 配置管理概述 回收站 新增导入导出任务中心章节。 2023-09-28 第十九次正式发布。 优化如下章节： 上架流模板 从空白开始创建流 删除流 内置函数 变量 开天企业工作台 2023-09-08 第十八次正式发布。 新增Code代码(简易版)章节。 2023-09-05 第十七次正式发布。 新增如下章节： 使用离线构建新建屏幕 优化如下章节： 使用模板构建新建屏幕 使用在线构建新建卡片 管理卡片 2023-08-18 第十六次正式发布。 优化如下章节： 连接器概述 创建连接器 创建触发事件 创建执行动作 连接管理 2023-08-08 第十五次正式发布。 新增如下章节。 输入输出定义 调用子流程 华为天气服务 修改如下章节： 从空白开始创建流 使用流模板创建流 创建函数 创建执行动作 MySQL webSocket连接器 HMS位置服务 华为位置服务 航班时刻票价查询 删除如下章节： 新业务对象 华为会议 华为空气质量 HMS静态地图 域名注册服务 Math连接器 飞书OKR 金蝶云星空 分享销客CRM 小鹅通 企业微信素材管理 企业微信 云数据迁移CDM 微博 黄金数据 飞书即时信息 飞书通讯录 查看猫品种信息 WeLink 2023-08-04 第十四次正式发布。 优化如下章节： 业务可视化概述 业务可视化使用流程 新建屏幕模板 新建卡片模板 模型地图（新版） 模型目录（新版） 删除如下章节： 共享屏幕模板 共享公共卡片模板 2023-07-05 第十三次正式发布。 优化如下章节： 使用在线构建新建卡片 2023-5-30 第十二次正式发布。 新增如下章节： 内置函数 优化如下章节： 从空白开始创建流 上架连接器 2023-5-10 第十一次正式发布。 新增如下章节： 数据解析 优化如下章节： 汇率查询 2023-04-27 第十次正式发布。 优化如下章节： 共享流模板 从空白开始创建流 使用流模板创建流 配置管理 共享函数 共享连接器 SQL执行器 JSON构造器 华为云OBS 2023-04-07 第九次正式发布。 新增如下章节： 业务可视化 业务可视化概述 业务可视化使用流程 我的屏幕 新建项目 新建屏幕 我的屏幕轮播 我的卡片 新建卡片分类 使用在线构建新建卡片 使用离线构建新建卡片 管理卡片 公共屏幕模板 新建屏幕模板分组 新建屏幕模板 发布屏幕模板 共享屏幕模板 公共卡片模板 新建卡片模板 查看预置卡片模板 共享公共卡片模板 配置管理 配置管理概述 新建布局 新建屏幕主题 新增自定义消息SO 回收站 优化如下章节： 开通并购买MSSI服务 首页 2023-03-31 第八次正式发布。 新增如下章节： 配置全局参数和连接信息 wait 优化如下章节： 共享流模板 从空白开始创建流 使用流模板创建流 创建函数 共享函数 创建连接器 创建触发事件 创建执行动作 共享连接器 Code代码 2023-03-09 第七次正式发布。 优化如下章节： 查看流模板 从空白开始创建流 使用流模板创建流 监控与日志 创建触发事件 创建执行动作 采集任务管理 新增如下章节： 边缘节点 通过模板创建业务资产 2023-01-18 第六次正式发布。 新增如下章节： websocket MQTT 足球联赛 NBA赛事 飞书云文档 语雀 站长之家 数据安全中心（DSC） 云日志服务LTS 实时汇率 小鹅通 企业微信素材管理 审计 优化如下章节： 监控与日志 API流 AOM运维告警 企业微信（服务端） 2022-12-14 第五次正式发布。 优化如下章节： 开通并购买MSSI服务 2022-11-30 第四次正式发布。 新增如下章节： 管理流标签 分配流至项目 沪深股票 世界时区时间 全国景点查询 性格测试 股票历史行情查询 银行网点查询 全国高校信息查询 医院信息查询 商品条形码查询 药品查询 台风预警 科学计算器 汇率换算 企业开票税号查询 字符串处理 优化如下章节： 开通MSSI服务 从空白开始创建流 复制流 创建连接器 WeatherAPI 企业微信（服务端） 2022-11-07 第三次正式发布。 新增如下章节： 首页 HTTP（IAM认证） HTTP（apiKey认证） 消息中间件（RocketMQ） MySQL 华为位置服务 限制高消费查询 英文励志语录 随机密码生成 历史上的今天 企业工商信息查询 企业经营状况查询 企业经营风险查询 银行卡归属地查询 黄金价格查询 白银价格查询 手机号空号检测 全国快递物流查询 查询海关编码 查看流历史版本 优化如下章节： 创建执行动作 创建连接器 创建流 创建函数 2022-10-08 第二次正式发布。 新增如下章节： 准备工作 共享连接器 公共连接器 函数 Astro轻应用 优化如下章节： 流编排 连接器 API生命周期 应用模型 集成项目管理 2022-04-30 第一次正式发布。

创建执行动作 连接器需要添加执行动作（连接器具有的功能）并发布后，才能被使用。 在连接器详情界面，在“执行动作”页签，单击“创建执行动作”。 配置执行动作基本信息，如图3所示，请参考表2。 图3 配置执行动作基本信息 表2 执行动作基本信息说明 参数 说明 示例 名称 必填项。 执行动作的名称，根据规划自定义。建议您按照一定的命名规则填写执行动作的名称，方便您快速识别和查找。 IP地址查询 类型 必选项。 API：通过调用API的方式创建执行动作。 函数：通过自定义函数的方式创建执行动作。函数类型支持CDM集成。 流：通过编排流的方式创建执行动作。 API 可见性 必选项。 可见：在流编排中该执行动作可见。缺省值为“可见”。 隐藏：在流编排中该执行动作不可见。 可见 描述 选填项。 连接器的描述信息，该描述将显示在连接器的详情中，帮助用户了解连接器。 IP地址查询 单击“下一步”。 配置执行动作输入信息，如图4所示，请参考表3。 根据被调用的接口请求信息配置参数。 图4 配置执行动作输入信息 表3 执行动作输入信息说明 参数 说明 示例 接口路径 请求方式：被调用API的请求方式。 请求路径：被调用API的请求路径。 GET /lundear/qryip 输入参数 请求头（Header） HTTP请求消息的组成部分之一，请求头负责通知服务器有关于客户端请求的信息。 - 请求体（Body） 当请求方式为“GET”或“DELETE”时，此参数不可配置。 HTTP请求消息的组成部分之一，请求体呈现发送给服务器的数据。 - 查询参数（Query） 查询参数会追加到URL。 参数名称：ip 显示字段：ip地址 必填：勾选 参数类型：string 路径参数（Path） 路径与路径模板一起使用，其中参数值实际上是操作URL的一部分。 - 单击“下一步”。 配置输出信息。 根据被调用的接口响应信息配置参数。 如图5所示，请参考表4。 单击“确定”，在批量导入的参数中填写显示字段别名方便阅读。如图6所示。 图5 配置执行动作输出信息1 图6 配置执行动作输出信息2 表4 执行动作输出信息说明 参数 说明 示例 添加响应 被调用API的响应码信息。缺省值为“200（请求成功）”。 200（请求成功） 输出参数 响应体（Body） HTTP响应消息的组成部分之一，响应体呈现发送给服务器的数据。 说明： 如果响应体使用XML格式，XML header参数必须配置。 { "status": 0, "message": "Success", "request_id": "2dd71feb-2f7a-4426-b905-4c3ff4dcceb4", "result": { "ip": "112.36.236.188", "location": { "lat": 36.68013, "lng": 117.06533 }, "ad_info": { "nation": "中国", "province": "山东省", "city": "济南市", "district": "历城区", "adcode": 370112 } } } 响应头（Header） HTTP响应消息的组成部分之一，响应头负责通知服务器有关于客户端请求的信息。 - 单击“保存”。 创建执行动作后，系统自动返回至连接器详情页面，执行动作显示在“执行动作”页签列表中。连接器“状态”变为“待发布”。

修订记录 发布日期 修订记录 2024-06-03 第十八次正式发布。 优化创建连接器章节。 2024-04-19 第十七次正式发布。 优化创建连接器章节。 2024-01-31 第十六次正式发布。 优化如下章节。 创建卡片模板 创建卡片 创建屏幕模板 创建屏幕 创建屏幕轮播 2024-01-09 第十五次正式发布。 优化创建屏幕章节。 2023-11-10 第十四次正式发布。 优化如下章节： 创建卡片模板 创建卡片 创建屏幕模板 2023-10-19 第十三次正式发布。 新增如下章节： 创建屏幕轮播 创建屏幕轮播简介 创建卡片模板 创建卡片 创建屏幕模板 创建屏幕 创建屏幕轮播 2023-09-20 第十二次正式发布。 优化获取API接口章节。 2023-08-08 第十一次正式发布。 优化如下章节： 使用流模板创建流 使用公共连接器创建流 创建连接器 创建流 运行流 2023-06-30 第十次正式发布。 优化全部章节目录及内容。 2023-06-06 第九次正式发布。 优化如下章节： 创建业务模型（以数字政府场景的业务模型为例） 采集技术模型（以MySQL数据源为例） 2023-05-30 第八次正式发布。 优化章节：创建一个连接器 2023-04-27 第七次正式发布。 优化章节：创建一个流 2023-04-07 第六次正式发布。 新增章节：创建一个屏幕轮播 2023-03-09 优化章节：使用公共连接器创建流 2022-11-18 第三次正式发布。 优化如下章节： 创建和使用一个函数 创建业务模型（以数字政府场景的业务模型为例） 采集技术模型（以MySQL数据源为例） 2022-11-02 第二次正式发布。 新增如下章节： 创建业务模型（以数字政府场景的业务模型为例） 采集技术模型（以MySQL数据源为例） 2022-09-29 第一次正式发布。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 offset 否 Integer 分页符。从第一条数据偏移offset页数据后开始查询，默认为0（偏移0页数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第11~20条数据。 limit 否 Integer 每页显示的条目数量,取值范围[1, 100]，默认10。

响应示例 查询数据库列表成功。 { "databases": [ { "name": "gaussdb_test", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test1", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test2", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" } ], "total_count": 3 }

响应参数 表2 参数说明 参数 参数类型 描述 databases Array of objects 列表中每个元素表示一个数据库。详情参见表3。 total_count Integer 总记录数。 表3 databases字段数据结构说明 参数 参数类型 描述 name String 数据库名称。 owner String 数据库所属用户。 character_set String 数据库使用的字符集，例如UTF8。 collate_set String 数据库排序集，例如en_US.UTF-8等。 size String 数据库大小。 datctype String 数据库使用的字符分类，例如en_US.UTF-8等。 compatibility_type String 数据库兼容的类型，如GaussDB，M。

请求示例 修改实例的参数failed_login_attempts的值为4。不需要重启。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations { "values": { "failed_login_attempts": "4" } } 修改实例的参数track_activity_query_size的值为2048，修改参数max_replication_slots的值为25。需要重启。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations { "values": { "track_activity_query_size": "2048", "max_replication_slots": "25" } }

响应示例 查询任务列表成功。 { "tasks" : [ { "instance_info" : { "instance_id" : "ce2dce50f365430abe161bab79495a6ein14", "instance_name" : "gauss-6568-zzh", "instance_status" : "creating" }, "job_id" : "03bc055a-135c-4245-8bd8-b0bc6d3350b3", "name" : "CreateGaussDBV5Instance", "status" : "Failed", "process" : null, "fail_reason" : "ECS云服务器处理异常。", "created_at": "2022-08-05T08:15:07+0800", "ended_at": "2022-08-09T03:06:52+0800" }, { "instance_info" : { "instance_id" : "20ba433bd7ee40da9cf35064f04f9e4cin14", "instance_name" : "gauss-7875-lt-m", "instance_status" : "deleted" }, "job_id" : "2cc16e0b-75ab-4a28-9453-16517e990bba", "name" : "DeleteGaussDBV5Instance", "status" : "Completed", "process" : null, "fail_reason" : null, "created_at": "2022-08-06T09:15:07+0800", "ended_at": "2022-08-10T03:06:52+0800" } ], "total_count" : 2 }

请求示例 查询任务状态为“运行中”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 查询任务状态为“完成”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&name=CreateGaussDBV5Instance&offset=1&limit=10 查询任务状态为“失败”的任务列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&name=CreateGaussDBV5Instance&offset=1&limit=10

响应参数 表2 要素说明 名称 参数类型 说明 tasks Array of objects 任务列表。 详情请参见表3 tasks字段数据结构说明。 total_count Integer 任务数量。 表3 tasks字段数据结构说明 名称 参数类型 说明 instance_info Object 任务绑定的实例信息。 详情请参见表4 instance_info字段数据结构说明。 job_id String 任务ID。 name String 任务名称。 status String 任务状态。 process String 任务进度，单位：%。 fail_reason String 失败原因。 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 ended_at String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 表4 instance_info字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。

URI GET https://{Endpoint}/v3/{project_id}/tasks 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 status 否 String 任务状态。 Running：运行中 Completed：完成 Failed：失败 name 否 String 任务名称。 CreateGaussDBV5Instance：创建实例。 BackupSnapshotGaussDBV5InInstance：手动创建备份。 CloneGaussDBV5NewInstance：恢复到新实例。 RestoreGaussDBV5InInstance：恢复到当前实例。 RestoreGaussDBV5InInstanceToExistedInst：恢复到已有实例 DeleteGaussDBV5Instance：删除实例。 EnlargeGaussDBV5Volume：磁盘扩容。 ResizeGaussDBV5Flavor：规格变更。 GaussDBV5ExpandClusterCN：协调节点扩容。 GaussDBV5ExpandClusterDN：分片扩容。 start_time 否 String 开始时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time 否 String 结束时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100

PG_STATIO_SYS_SEQUENCES PG_STATIO_SYS_SEQUENCES视图显示命名空间中所有序列的I/O状态信息。 表1 PG_STATIO_SYS_SEQUENCES字段 名称 类型 描述 relid oid 序列OID。 schemaname name 序列的模式名。 relname name 序列名。 blks_read bigint 从序列中读取的磁盘块数。 blks_hit bigint 序列命中缓存数。 父主题： 其他系统视图

GLOBAL_REPLICATION_STAT GLOBAL_REPLICATION_STAT视图用于获得各节点描述日志同步状态信息，如发起端发送日志位置、接收端接收日志位置等，如表1所示。 表1 GLOBAL_REPLICATION_STAT字段 名称 类型 描述 node_name name 节点名称。 pid bigint 线程的PID。 usesysid oid 用户系统ID。 usename name 用户名。 application_name text 程序名称。 client_addr inet 客户端地址。 client_hostname text 客户端名。 client_port integer 客户端端口。 backend_start timestamp with time zone 程序启动时间。 state text 日志复制的状态： 追赶状态 一致的流状态 sender_sent_location text 发送端发送日志位置。 receiver_write_location text 接收端write日志位置。 receiver_flush_location text 接收端flush日志位置。 receiver_replay_location text 接收端replay日志位置。 sync_priority integer 同步复制的优先级（0表示异步）。 sync_state text 同步状态： 异步复制 同步复制 潜在同步者 父主题： Utility

ADM_TAB_PRIVS ADM_TAB_PRIVS视图显示数据库中所有对象的授权信息。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_TAB_PRIVS字段 名称 类型 描述 grantee character varying(128) 被授予权限的用户或角色的名称。 owner character varying(128) 对象的所有者。 table_name character varying(128) 对象的名称。 grantor character varying(128) 执行授权的用户名。 privilege character varying(40) 对象上的权限，包括USAGE、UPDATE、DELETE、INSERT、CONNECT、SELECT、EXECUTE。 grantable character varying(3) 该授权是否包含GRANT选项。 YES：包含GRANT选项。 NO：不包含GRANT选项。 type character varying(24) 对象的类型，包括NODE GROUP、COLUMN_ENCRYPTION_KEY、PACKAGE、COLUMN、TABLE、VIEW、SEQUENCE、TYPE、INDEX、DATABASE、DIRECTORY、FOREIGN DATA WRAPPER、FOREIGN SERVER、LANGUAGE、LARGE OBJECT、SCHEMA、TEMPLATE、FUNCTION、PROCEDURE、TABLESPACE。 hierarchy character varying(3) 暂不支持，值为NULL。 common character varying(3) 暂不支持，值为NULL。 inherited character varying(3) 暂不支持，值为NULL。 父主题： 用户和权限管理

GV_INSTANCE GV_INSTANCE视图显示当前数据库实例的信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS schema下。 表1 GV_INSTANCE字段 名称 类型 描述 inst_id oid 当前数据库oid。 instance_number oid 当前数据库oid。 instance_name character varying(16) 当前数据库名。 host_name character varying(64) 暂不支持，值为NULL。 version character varying(17) 暂不支持，值为NULL。 version_legacy character varying(17) 暂不支持，值为NULL。 version_full character varying(17) 暂不支持，值为NULL。 startup_time timestamp(0) without time zone 暂不支持，值为NULL。 status character varying(12) 暂不支持，值为NULL。 parallel character varying(3) 暂不支持，值为NULL。 thread# numeric 暂不支持，值为NULL。 archiver character varying(7) 暂不支持，值为NULL。 log_switch_wait character varying(15) 暂不支持，值为NULL。 logins character varying(10) 暂不支持，值为NULL。 shutdown_pending character varying(3) 暂不支持，值为NULL。 database_status character varying(17) 暂不支持，值为NULL。 instance_role character varying(18) 暂不支持，值为NULL。 active_state character varying(9) 暂不支持，值为NULL。 blocked character varying(3) 暂不支持，值为NULL。 con_id numeric 暂不支持，值为NULL。 instance_mode character varying(11) 暂不支持，值为NULL。 edition character varying(7) 暂不支持，值为NULL。 family character varying(80) 暂不支持，值为NULL。 database_type character varying(15) 暂不支持，值为NULL。 父主题： 其他系统视图

PG_REPLICATION_ORIGIN PG_REPLICATION_ORIGIN系统表包含所有已创建的复制源，该表在数据库实例的所有数据库之间共享，即每个实例只有一份，而不是每个数据库一份。 表1 PG_REPLICATION_ORIGIN字段 名称 类型 描述 roident oid 一个数据库实例范围内唯一的复制源标识符。 roname text 外部的由用户定义的复制源名称。 父主题： 其他系统表

GLOBAL_FILE_REDO_IOSTAT 显示数据库内各节点的Redo(WAL)相关统计信息，如表1所示。 表1 GLOBAL_FILE_REDO_IOSTAT字段 名称 类型 描述 node_name name 节点名称。 phywrts bigint 向wal buffer中写的次数。 phyblkwrt bigint 向wal buffer中写的block的块数。 writetim bigint 向xLog文件中写操作的时间（单位：微秒）。 avgiotim bigint 平均写xLog的时间（writetim/phywrts，单位：微秒）。 lstiotim bigint 最后一次写xLog的时间（单位：微秒）。 miniotim bigint 最小的写xLog时间（单位：微秒）。 maxiowtm bigint 最大的写xLog时间（单位：微秒）。 父主题： File

STAT_ALL_TABLES 显示数据库当前节点每个表（包括TOAST表）的状态信息，如表1所示。 表1 STAT_ALL_TABLES字段 名称 类型 描述 relid oid 表的OID。 schemaname name 该表所在的Schema名。 relname name 表名。 seq_scan bigint 该表发起的顺序扫描数。 seq_tup_read bigint 顺序扫描抓取的活跃行数。 idx_scan bigint 该表发起的索引扫描数。 idx_tup_fetch bigint 索引扫描抓取的活跃行数。 n_tup_ins bigint 插入行数。 n_tup_upd bigint 更新行数。 n_tup_del bigint 删除行数。 n_tup_hot_upd bigint HOT更新行数（即没有更新索引列的行数）。 n_live_tup bigint 估计活跃行数。 n_dead_tup bigint 估计不活跃行数。 last_vacuum timestamp with time zone 最后一次该表是手动清理的（不计算VACUUM FULL）的时间。 last_autovacuum timestamp with time zone 上次被autovacuum守护线程清理的时间。 last_analyze timestamp with time zone 上次手动分析该表的时间。 last_autoanalyze timestamp with time zone 上次被autovacuum守护线程分析时间。 vacuum_count bigint 该表被手动清理的次数（不计算VACUUM FULL）。 autovacuum_count bigint 该表被autovacuum清理的次数。 analyze_count bigint 该表被手动分析的次数。 autoanalyze_count bigint 该表被autovacuum守护线程分析的次数。 last_updated timestamp with time zone 视图中该对象监控数据最后一次更新的时间。 父主题： Object

用户权限设置 给用户直接授予某对象的权限，请参见GRANT。 将Schema中的表或者视图对象授权给其他用户或角色时，需要将表或视图所属Schema的USAGE权限同时授予该用户或角色。否则用户或角色将只能看到这些对象的名称，并不能实际进行对象访问。 例如，下面示例将Schema tpcds的权限授予用户joe后，将表tpcds.web_returns的select权限授予用户joe。 1 2 gaussdb=# GRANT USAGE ON SCHEMA tpcds TO joe; gaussdb=# GRANT SELECT ON TABLE tpcds.web_returns to joe; 给用户指定角色，使用户继承角色所拥有的对象权限。 创建角色。 新建一个角色lily，同时给角色指定系统权限CREATEDB。 1 gaussdb=# CREATE ROLE lily WITH CREATEDB PASSWORD "********"; 给角色授予对象权限，请参见GRANT。 例如，将模式tpcds的权限赋给角色lily后，将表tpcds.web_returns的select权限授予角色lily。 1 2 gaussdb=# GRANT USAGE ON SCHEMA tpcds TO lily; gaussdb=# GRANT SELECT ON TABLE tpcds.web_returns to lily; 将角色的权限授予用户。 1 gaussdb=# GRANT lily to joe; 当将角色的权限授予用户时，角色的属性并不会传递到用户。 回收用户权限，请参见REVOKE。 父主题： 用户及权限