华为云用户手册

  • 计费场景 按需计费场景:某用户于2023/03/18 15:00:00购买了一个Doris集群,集群使用时间为1小时。使用0.5个小时后对FE节点规格进行变更(8U16G变更为8U32G)。由于该集群要长期使用,所以2023/03/18 15:59:59将集群计费模式转为包年/包月计费,购买时长为1个月,那么3~4月份,该集群总共产生多少费用?规格配置如下: FE节点 计算规格:8U16G。 存储规格:高IO,容量300GB/节点。 节点数量:5个。 BE节点 计算规格:8U16G。 存储规格:高IO,容量400GB/节点。 节点数量:3个。
  • 计费构成分析 基于此样例,可以详细计算出变更规格前后的消费情况。 表1 变更计费模式 计费模式 计算规则 付费周期 费用计算 按需计费(变更规格前) CU费用:CU单价 x 节点数 平均每小时的费用 计算节点CU费用:1.4(CU单价:元/小时)x 2(节点)x 1小时 = 2.80元 ZooKeeper节点CU费用:1.4(CU单价:元/小时)x 3(节点)x 1小时= 4.20元 磁盘费用: 磁盘单价 x 容量 x 节点 计算节点磁盘费用:0.00097(磁盘单价:元/小时)x 500(容量:GB)x 2(节点)x 0.5小时=0.485元 ZooKeeper节点磁盘费用:0 总费用:7.485元 按需计费(变更规格后) CU费用:CU单价 x 节点数 平均每小时的费用 计算节点CU费用:1.4(CU单价:元/小时)x 2(节点)x 1小时= 2.80元 ZooKeeper节点CU费用:2.8(CU单价:元/小时)x 3(节点)x 1小时 = 8.40元 磁盘费用: 磁盘单价 x 容量 x 节点 计算节点磁盘费用:0.00097(磁盘单价:元/小时)x 500(容量:GB)x 2(节点)x 1小时=0.97元 ZooKeeper节点磁盘费用:0 总费用:12.17元 包年/包月 CU费用:CU单价 x 节点数 平均每月的费用 计算节点CU费用:680(CU单价:元/月)x 2(节点) = 1360元 ZooKeeper节点CU费用:1360(CU单价:元/月)x 3(节点) = 4080元 磁盘费用: 磁盘单价 x 容量 x 节点 计算节点磁盘费用:0.35(磁盘单价:元/月)x 500(容量:GB)x 2(节点)=350元 ZooKeeper节点磁盘费用:0 合计 总费用:5790元 ClickHouse组件是按照小时收费的,CU未满1小时,按照1小时收费。 变更按需集群计费规则: 磁盘计费规则:半小时内按照变更前规格计费,变更后整个周期按照变更规格计费。 CU计费规则:半小时内按照变更前规格计费,变更后整个周期按照变更规则计费。 按需产品周期结算说明: 按小时结算:华为云会每小时根据您的使用量计算费用,并到账户中进行扣费。例如,8:00~9:00期间产生的费用,通常会在10:00以前完成扣费。 按月结算:华为云会根据您的使用量计算费用,每月月初对前一月使用量进行扣费。例如,2019-04-01 00:00:00 至2019-04-30 23:59:59期间产生的费用,通常会在2019-05-01 01:00:00左右完成扣费。 由此可见,在3~4月份,该ClickHouse集群总共产生费用为:12.17+5790=5802.17元。
  • 步骤一:购买Doris集群 登录 表格存储服务 控制台。 在控制台左上角选择区域。 单击“集群管理”进入集群管理界面。 单击集群管理界面右上角的“购买集群”,进入购买集群页面配置相关参数(安全组规则配置端口请参见Doris安全规则组)。 单击“立即购买”,进入确认规格页面,确认无误,单击“完成”。 返回集群列表查看创建集群进度,当集群状态为“服务中”时,集群创建成功,详细参见创建Doris集群。 表3 Doris安全规则组 方向 策略 协议端口/范围 类型 目的/源地址 用途 出方向 允许 全部 IPv4/IPv6 0.0.0.0/0 出方向放行。 入方向 允许 9030 CloudTable Doris集群所在的安全组。 FE上的mysql server端口。 允许 8030 FE上的http server端口。 允许 8040 BE上的http server的端口。 允许 8050 FE上的https server端口
  • 背景信息 假定这是一张记录用户访问某商品页面行为的表信息,使用MySQL客户端实现业务操作: 创建用户信息表example_tbl。 在用户信息中新增访问时间、城市、性别、停留时长、花费。 根据用户user_id查询用户的基本信息。 业务结束后,删除用户信息表。 表1 原始数据 user_id date city age sex last_visit_date cost max_dwell_time min_dwell_time 10000 2017-10-01 A 20 0 2017-10-01 06:00:00 20 10 10 10000 2017-10-01 A 20 0 2017-10-01 07:00:00 15 2 2 10001 2017-10-01 A 30 1 2017-10-01 17:05:45 2 22 22 10002 2017-10-02 B 20 1 2017-10-02 12:59:12 200 5 5 10003 2017-10-02 C 32 0 2017-10-02 11:20:00 30 11 11 10004 2017-10-01 D 35 0 2017-10-01 10:00:15 100 3 3 10004 2017-10-03 D 35 0 2017-10-03 10:20:22 11 6 6 字段含义说明。 表2 参数说明 数据 说明 10000 用户id,每个用户唯一识别id。 2017-10-01 数据入库时间,精确到日期。 A 用户所在城市。 20 用户年龄。 0 性别男(1代表女性)。 2017-10-01 06:00:00 用户本次访问该页面的时间,精确到秒。 20 用户本次访问产生的消费。 10 用户本次访问,驻留该页面的时间。 10 用户本次访问,驻留该页面的时间(冗余)。
  • 背景信息 假定这是一张学生成绩表信息,使用客户端实现业务操作: 创建用户信息表demo_t。 在用户信息中新增访问性别、科目。 根据用户user_id查询用户的基本信息。 业务结束后,删除用户信息表。 表1 成绩表 user_id name sex subject score time 10000 A 1 语文 89 2023-07-01 09:00:00 10001 B 0 数学 132 2023-07-01 09:00:00 10002 C 0 数学 90 2023-07-02 09:00:00 10003 D 0 英语 120 2023-07-01 14:00:00 10004 E 1 语文 101 2023-07-01 09:00:00 10005 F 1 语文 110 2023-07-01 09:00:00 表2 参数说明 参数 说明 10000 用户id,每个用户唯一识别id。 2023-07-01 09:00:00 数据入库时间。 A 学生姓名。 1 性别女(0代表男生)。 语文 代表学科。 89 代表学成绩。
  • 步骤一:购买ClickHouse集群 登录 表格存储 服务控制台。 在控制台左上角选择区域。 单击“集群管理”进入集群管理界面。 单击集群管理界面右上角的“购买集群”,进入购买集群页面配置相关参数(安全组规则配置端口请参见ClickHouse安全规则组)。 单击“立即购买”,进入确认规格页面,确认无误,单击“完成”。 返回集群列表查看创建集群进度,当集群状态为“服务中”时,集群创建成功,详细参见创建ClickHouse集群。 表3 ClickHouse安全规则组 方向 策略 协议端口/范围 类型 目的/源地址 说明 出方向 允许 全部 IPv4/IPv6 0.0.0.0/0 出方向放行。 入方向 允许 8123 CloudTable ClickHouse集群所在的安全组。 ClickHouse的Http协议端口。 允许 9000 ClickHouse的TCP协议端口。 允许 8443 ClickHouse的Https协议端口。 允许 9440 ClickHouse的安全TCP安全端口。 允许 2181 监听ZooKeeper客户端连接监听端口。
  • 步骤六:插入数据 在步骤五的命令窗口中执行以下命令,使用ClickHouse集群快速创建数据表,并对表数据进行查询。 创建数据库。 create database DB_demo; 使用数据库。 use DB_demo; 创建表。 create table DB_demo_t(user_id Int32,name String,sex Tinyint ,subject String,score Int32,time datetime)engine=TinyLog; 插入数据。 insert into DB_demo_t(user_id,name,sex,subject,score,time) values('10000','A','1','语文','89','2023-07-01 09:00:00'); insert into DB_demo_t(user_id,name,sex,subject,score,time) values('10001','B','0','数学','132','2023-07-01 09:00:00'); insert into DB_demo_t(user_id,name,sex,subject,score,time) values('10002','C','0','数学','90','2023-07-02 09:00:00'); insert into DB_demo_t(user_id,name,sex,subject,score,time) values('10003','D','0','英语','120','2023-07-01 14:00:00'); insert into DB_demo_t(user_id,name,sex,subject,score,time) values('10004','E','1','语文','101','2023-07-01 09:00:00'); insert into DB_demo_t(user_id,name,sex,subject,score,time) values('10005','F','1','语文','110','2023-07-01 09:00:00'); 查询数据。 查询导入的数据。 host-172-16-13-95 :) select * from DB_demo_t; SELECT * FROM DB_demo_t Query id: 4e119f77-0592-4131-bbe2-31f42bc069a1 ┌─user_id─┬─name─┬─sex─┬─subject─┬─score─┬────────────────time─┐ │ 10000 │ A │ 1 │ 语文 │ 89 │ 2023-07-01 09:00:00 │ │ 10001 │ B │ 0 │ 数学 │ 132 │ 2023-07-01 09:00:00 │ │ 10002 │ C │ 0 │ 数学 │ 90 │ 2023-07-02 09:00:00 │ │ 10003 │ D │ 0 │ 英语 │ 120 │ 2023-07-01 14:00:00 │ │ 10004 │ E │ 1 │ 语文 │ 101 │ 2023-07-01 09:00:00 │ │ 10005 │ F │ 1 │ 语文 │ 110 │ 2023-07-01 09:00:00 │ └─────────┴──────┴─────┴────────┴───────┴─────────────────────┘ 6 rows in set. Elapsed: 0.004 sec. 删除数据。 删除表。 drop table DB_demo_t; 删除数据库。 drop database DB_demo;
  • 前提条件 CloudTable服务暂不支持细粒度策略,仅支持系统角色“cloudtable Administrator”。当前CloudTable默认的系统角色“cloudtable Administrator” 仅适用于未开通企业项目的账号,如已开通,请使用 IAM 自定义策略并直接给用户授权。 给用户组授权之前,请您了解用户组可以添加的CloudTable权限,并结合实际需求进行选择,CloudTable支持的系统权限,请参见:CloudTable系统权限。如果您需要对除CloudTable之外的其它服务授权,IAM支持服务的所有权限请参见权限策略。
  • 示例流程 图1 给用户授权CloudTable权限流程 创建用户组并授权 使用云登录IAM控制台,创建用户组,并授予表格存储服务的管理员权限“cloudtable Administrator”。 创建用户并加入用户组。 在IAM控制台创建用户,并将其加入步骤1中创建的用户组。 用户登录并验证权限。 使用新创建的用户登录控制台,切换至授权区域,验证权限: 在“服务列表”中选择表格存储服务,进入CloudTable主界面,单击右上角“购买集群”,尝试创建表格存储服务集群,如果可以创建(假设当前权限仅包含cloudtable Administrator),表示“cloudtable Administrator”已生效。 在“服务列表”中选择除表格存储服务之外(假设当前策略仅包含cloudtable Administrator)的任一服务,如果提示权限不足,表示“cloudtable Administrator”已生效。
  • 通过IAM账户使用CloudTable 如果您需要对您所拥有的云服务进行精细的权限管理,您可以使用 统一身份认证 服务(Identity and Access Management,简称IAM)。通过IAM,您可以: 根据企业的业务组织,在您的云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用云服务资源。 根据企业用户的职能,设置不同的访问权限,以达到用户之间的权限隔离。 将云服务资源委托给更专业、高效的其他云账号或者云服务,这些账号或者云服务可以根据权限进行代运维。 如果云账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用CloudTable服务的其它功能。 本章节为您介绍对用户授权的方法,操作流程如图1所示。
  • 示例流程 图1 给用户授权CloudTable权限流程 创建用户组并授权 使用云登录IAM控制台,创建用户组,并授予表格存储服务的管理员权限“cloudtable Administrator”。 创建用户并加入用户组。 在IAM控制台创建用户,并将其加入步骤1中创建的用户组。 用户登录并验证权限。 使用新创建的用户登录控制台,切换至授权区域,验证权限: 在“服务列表”中选择表格存储服务,进入CloudTable主界面,单击右上角“购买集群”,尝试创建表格存储服务集群,如果可以创建(假设当前权限仅包含cloudtable Administrator),表示“cloudtable Administrator”已生效。 在“服务列表”中选择除表格存储服务之外(假设当前策略仅包含cloudtable Administrator)的任一服务,如果提示权限不足,表示“cloudtable Administrator”已生效。
  • 通过IAM账户使用CloudTable 如果您需要对您所拥有的云服务进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM)。通过IAM,您可以: 根据企业的业务组织,在您的云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用云服务资源。 根据企业用户的职能,设置不同的访问权限,以达到用户之间的权限隔离。 将云服务资源委托给更专业、高效的其他云账号或者云服务,这些账号或者云服务可以根据权限进行代运维。 如果云账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用CloudTable服务的其它功能。 本章节为您介绍对用户授权的方法,操作流程如图1所示。
  • 前提条件 CloudTable服务暂不支持细粒度策略,仅支持系统角色“cloudtable Administrator”。当前CloudTable默认的系统角色“cloudtable Administrator” 仅适用于未开通企业项目的账号,如已开通,请使用IAM自定义策略并直接给用户授权。 给用户组授权之前,请您了解用户组可以添加的CloudTable权限,并结合实际需求进行选择,CloudTable支持的系统权限,请参见:CloudTable系统权限。如果您需要对除CloudTable之外的其它服务授权,IAM支持服务的所有权限请参见权限策略。
  • HBase热点自愈 HBase是一个分布式的KV数据库,Region是HBase数据管理的最小单元。如果用户在规划表和设计rowkey不合理,请求过于集中在少量固定Region时,会导致业务压力集中在单节点,造成业务侧可感知的性能下降甚至请求失败。 HBase服务增加了MetricController实例,开启热点检测能力,能够监控每个RegionServer节点的请求流量,通过聚合分析,识别出请求偏高的节点和Region,有助于快速发现热点问题;并提供一定的热点问题自愈能力,比如热点Region自动转移或Split。对于无法提供自愈的热点场景(单rowkey热点、顺序写热点等),提供了热点限流的能力,避免单点问题影响同节点的其他正常业务。 父主题: 企业级能力增强
  • ClickHouse集群管理简介 ClickHouse是面向联机分析处理的列式数据库,其独立于Hadoop大数据体系,最核心的特点是压缩率和极速查询性能。同时支持SQL查询,且查询性能好,特别是基于大宽表的聚合分析查询性能非常优异,比其他分析型数据库速度快一个数量级。CloudTable ClickHouse集群管理还有以下功能: ClickHouse集群管理下,用户申请专属集群,按需使用,专属集群是物理隔离且不受其他业务影响,方便用户管理。 ClickHouse集群创建成功后,使用客户端访问集群,请参见以下章节。 准备弹性云服务。 使用客户端访问集群。 ClickHouse命令简介。 父主题: ClickHouse集群管理
  • 环境准备 要将表复制到另一个集群,请先获取CloudTable HBase目标集群的“ZK链接地址(内网)”。 登录表格存储服务管理控制台,在左侧导航树单击集群管理,然后在集群列表中找到所需要的集群,并获取相应的“ZK链接地址(内网)”。 在复制表数据前,需要先确保在CloudTable HBase目标集群中目标表已经存在。如果目标表不存在,请先创建目标表。 创建表的具体步骤,请参考创建HBase集群。 下载样例代码,然后参考准备开发环境章节准备开发环境。 如果您不准备使用样例代码的工程,需要将下载的样例代码中“cloudtable-example\lib”目录下的jar包拷贝到您的项目中,并在项目工程中将这些Jar包添加到依赖路径中。
  • 支持的关键操作审计日志 CloudTable使用 云审计 服务,可以记录与CloudTable服务相关的操作事件,便于日后的查询、审计和回溯。 CloudTable的以下关键操作事件将记录审计日志,详细内容如表1所示。 表1 云审计服务支持的CloudTable操作事件列表 操作名称 事件名称 资源类型 创建集群 createCloudTableClusterV3 cluster 节点扩容 growCloudTableCluster cluster 重启集群 rebootCloudTableCluster cluster 设置存储配额 storageClusterAction cluster 特性开关 modifyClusterFeatures cluster 参数配置 modifyClusterSetting cluster Doris绑定角色到用户 addAccountRole cluster Doris绑定用户到租户 bindAccountWithTenant cluster 修改HBase存储阈值大小 changeHbaseDiskUsedQuota cluster 创建数据迁移任务 copierCreateTask cluster 枚举数据库信息 copierListDatabaseInfo cluster 枚举集群节点信息 copierListNodeInfo cluster 数据迁移任务详情 copierTaskDetail cluster Doris创建catalog createCatalogV3 cluster Doris、ClickHouse创建用户 createCloudTableAccount cluster 创建角色 createRole cluster 创建租户 createTenante cluster Doris创建catalog测试 createTestCatalogV3 cluster Doris删除Catalog连接 deleteCatalogV3 cluster 删除集群 deleteCloudTableClusterV2 cluster 删除角色 deleteRole cluster 关闭集群日志 disableLTSAccess cluster 打开集群日志 enableLTSAccessc cluster Doris获取Catalogs getCatalogs cluster 获取集群信息 getClusterInfo cluster 获取数据库信息 getDatabases cluster 获取角色信息 getRoles cluster 获取表信息 getTables cluster 磁盘扩容 growCloudTableDisk cluster 规格扩容 growCloudTableFlavor cluster HBase修改配置参数 modifyClusterSetting cluster 修改Doris配置参数 modifyClusterSettingV3 cluster Doris修改角色权限 modifyRolePermission cluster 重启集群 rebootCloudTableClusterV2 cluster 重启节点 restartInstance cluster Doris修改租户 updateTenant cluster 重启 REBOOTING cluster 扩容 GROWING cluster 删除 DELETING cluster 关闭安全认证 switchHBaseAuthentication cluster 开启或关闭HBase thrift server switchThriftServer cluster 包周期集群扩容、规格变更 changeCloudTableCluster cluster ClickHouse同时开启安全和非安全通道 enableBothSslAndNone cluster 开启冷热分离 switchHotColdFeature cluster 创建租户 createTenant cluster Doris删除租户 deleteTenant cluster 查杀sql killQueryBySqlId cluster Doris、ClickHouse删除用户 deleteCloudTableAccount cluster Doris、ClickHouse更新用户 updateCloudTableAccount cluster 父主题: 审计日志
  • 入门实践 当用户购买并连接到CloudTable集群后,可以根据自身的业务需求使用CloudTable提供的一系列常用实践。 表1 常用最佳实践 实践 描述 数据导入 使用 DLI Flink作业实时同步 MRS Kafka数据至CloudTable HBase集群 本实践演示通过 数据湖探索 服务DLI Flink作业将分布式消息服务Kafka的消费数据实时同步至CloudTable HBase,实现Kafka实时入库到CloudTable HBase的过程。 使用DLI Flink作业实时同步MRS Kafka数据至CloudTable ClickHouse集群 本实践演示通过 数据湖 探索服务DLI Flink作业将分布式消息服务Kafka的消费数据实时同步至CloudTable ClickHouse,实现Kafka实时入库到CloudTable ClickHouse的过程。
  • 操作场景 假设某电商平台,需要实时分析用户订单行为,包括: 记录用户订单数据(用户ID、订单时间、金额、商品类别)。 快速查询特定时间段内的订单金额、热门商品类别。 表1 原始数据 user_id order_time amount category 101 2025-02-15 10:00:00 50.99 Electronics 102 2025-02-18 10:30:00 99.99 Clothing 103 2025-02-28 17:30:06 159.99 Cosmetics 104 2025-02-17 19:30:06 20.00 Shoes 105 2025-01-01 11:30:06 99.00 Drinks 106 2025-01-20 19:30:06 199.00 Furniture 107 2025-01-03 09:30:06 50.99 Kitchen
  • 步骤一:购买StarRocks集群 登录表格存储服务控制台。 在控制台左上角选择区域。 单击“集群管理”进入集群管理界面。 单击集群管理界面右上角的“购买集群”,进入购买集群页面配置相关参数(安全组规则配置端口请参见StarRocks安全规则组)。 单击“立即购买”,进入确认规格页面,确认无误,单击“完成”。 返回集群列表查看创建集群进度,当集群状态为“服务中”时,集群创建成功。 表2 StarRocks安全规则组 方向 策略 协议端口/范围 类型 目的/源地址 用途 出方向 允许 全部 IPv4/IPv6 0.0.0.0/0 出方向放行。 入方向 允许 9030 StarRocks集群所在的安全组。 FE上的mysql server端口。 允许 8030 FE上的http server端口。 允许 8040 BE上的http server的端口。 允许 8050 FE上的https server端口
  • 请求示例 使用图片的url POST https://{endpoint}/v3/{project_id}/moderation/image/batch { "event_type" : "comment", "categories" : [ "string" ], "image_text_config" : { "black_glossary_names" : [ "string" ], "white_glossary_names" : [ "string" ] }, "urls" : [ { "url" : "http://xxxxxx.com/qweqeqeqz.jpg", "data_id" : "1234" } ], "language" : "zh" } 使用bizType POST https://{endpoint}/v3/{project_id}/moderation/image/batch { "urls" : [ { "url" : "http://xxxxxx.com/qweqeqeqz.jpg", "data_id" : "1234" } ], "language" : "zh", "biz_type" : "test_type" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口,响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 event_type 否 String 事件类型。可选值如下: head_image:头像。 album:相册。 dynamic:动态。 article:帖子。 comment:评论。 room_cover:房间封面。 group_message:群聊图片。 message:私聊图片。 product:商品图片。 说明: 如果请求参数中包含biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果未传biz_type则event_type和categories为必传参数。 categories 否 Array of strings 检测场景。可添加的检测场景如下: terrorism:暴恐元素的检测。 porn:涉黄元素的检测。 image_text:广告图文的检测。 可通过配置上述场景,来完成对应场景元素的检测。每个检测场景的检测次数会分类统计。 说明: 如果请求参数中包含biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果未传biz_type则event_type和categories为必传参数。 image_text_config 否 image_text_config object 图文审核黑白词库配置。 urls 是 Array of urls objects 图片url列表。最大支持12张图片。 language 否 String 指定图片中文字语种类型。 zh: 中文(默认值为zh,中国站仅支持zh)。 biz_type 否 String 用户在控制台界面创建的自定义审核策略名称。该功能需申请开通后使用。 如果请求参数中包含biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果未传biz_type则event_type和categories为必传参数。 表4 image_text_config 参数 是否必选 参数类型 描述 black_glossary_names 否 Array of strings 检测时使用的自定义黑名单词库列表。 white_glossary_names 否 Array of strings 检测时使用的自定义白名单词库列表。 表5 urls 参数 是否必选 参数类型 描述 url 是 String 图片url,目前支持:公网HTTP/HTTPS URL。 data_id 是 String 图片唯一标识。同一次请求中不可重复,由大小写英文字母、数字、下划线(_)、中划线(-)组成,不超过30个字符。
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 results Array of ImageDetectionResult objects 调用结果。 表7 ImageDetectionResult 参数 参数类型 描述 suggestion String 审核结果是否通过。 block:包含敏感信息,不通过。 pass:不包含敏感信息,通过 。 review:需要人工复检。 category String 检测结果的一级标签。支持category列表如下: terrorism: 暴恐。 porn: 色情。 image_text: 图文审核。 details Array of ImageDetectionResultDetail objects 检测详情。 ocr_text String 图文审核检测出的文本,只有在category参数配置image_text且检测出文本时展示该字段。 data_id String 图片唯一标识。同一次请求中不可重复,由大小写英文字母、数字、下划线(_)、中划线(-)组成,不超过30个字符。 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 表8 ImageDetectionResultDetail 参数 参数类型 描述 suggestion String 审核结果是否通过。 block:包含敏感信息,不通过。 review:需要人工复检。 category String 检测结果的一级标签。支持category列表如下: terrorism: 暴恐。 porn: 色情。 image_text: 图文审核。 confidence Float 置信度,可选值在0-1之间,值越大,可信度越高。 face_location FaceLocationDetail object 人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567],207代表的是左上角的横坐标,522代表左上角的纵坐标,340代表的是右下角的横坐标,567代表的是右下角的纵坐标。 qr_location QRLocationDetail object 图片中二维码指向的链接,当请求参数categories中包含image_text时存在。 qr_content String 图片中二维码指向的链接,当请求参数categories中包含image_text时存在。 segments Array of OCRTextDetail objects image_text场景下命中的文本片段。 label String 识别的详细标签。 表9 FaceLocationDetail 参数 参数类型 描述 top_left_x Integer 检测出人脸的左上角横坐标。 top_left_y Integer 检测出人脸的左上角纵坐标。 bottom_right_x Integer 检测出人脸的右下角横坐标。 bottom_right_y Integer 检测出人脸的右下角纵坐标。 表10 QRLocationDetail 参数 参数类型 描述 top_left_x Integer 检测出的二维码左上角横坐标。 top_left_y Integer 检测出的二维码左上角纵坐标。 bottom_right_x Integer 检测出的二维码右下角横坐标。 bottom_right_y Integer 检测出的二维码右下角纵坐标。 表11 OCRTextDetail 参数 参数类型 描述 segment String 命中的风险片段。 glossary_name String 命中的自定义词库名称。命中自定义词库时,才会返回当前字段。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求示例 “endpoint”即调用API的请求地址,不同服务不同区域的endpoint不同,具体请参见终端节点。 例如,服务部署在“华北-北京四”区域的“endpoint”为“moderation.cn-north-4.myhuaweicloud.com”,请求URL为“https://moderation.cn-north-4.myhuaweicloud.com/v3/{project_id}/moderation/audio/jobs”,“project_id”为项目ID,获取方法请参见获取项目ID。 创建音频 内容审核 作业,事件类型为默认事件,检测的风险类型为涉黄,广告。 POST https://{endpoint}/v3/{project_id}/moderation/audio/jobs { "data" : { "url" : "https://xxxxx.wav" }, "event_type" : "default", "categories" : [ "porn", "ad" ], "callback" : "http://xxxx" }
  • 响应示例 状态码: 200 成功响应示例 { "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48", "request_id" : "07490f57ac5e034c077ab25b5f9e1da5" } 状态码: 400 失败响应示例 { "error_code": "AIS.0401", "error_msg": "The input parameter event_type is incorrect." }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 最小长度:2 最大长度:64 job_id String 作业唯一标识。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 data 是 AudioInputBody object 音频数据输入。 event_type 否 String 事件类型,可选值如下: default:默认事件 audiobook:有声书 education:教育音频 game:游戏语音房 live:秀场直播 ecommerce:电商直播 voiceroom:交友语音房 private:私密语音聊天 categories 否 Array of strings 需要检测的风险类型,列表不能为空。 风险类型如下: porn:涉黄检测 ad:广告检测 moan:娇喘检测 abuse:辱骂检测 callback 否 String 该字段非空时,检测结果会回调通知您的URL。该字段为空时,您需要定时轮询获取检测结果。 说明: 您的callback接口需要支持POST方法; 回调数据格式,请参考查询音频内容审核作业的响应示例; 您的服务端callback接口收到内容安全发送的结果后,如果在响应超时时间3秒内返回的HTTP状态码为200,则表示接收成功。其他HTTP状态码或响应时间大于3秒后返回状态码均视为接收失败,接收失败时,内容安全将重复发送多次检测结果。 biz_type 否 String 用户在控制台界面创建的自定义审核策略名称。该功能需申请开通后使用。 如果请求参数中传了biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果用户没传biz_type则event_type和categories必须传。 seed 否 String 用于回调通知时校验请求是由华为云内容安全服务发起,您可以自定义。值为随机字符串,由英文字母、数字、下划线组成,不超过64个字符。 说明: 当seed非空时,headers中将包含X-Auth-Signature字段,字段的值使用HmacSHA256算法生成,待加密字符串由create_time、job_id、request_id、seed按照顺序拼接而成,密钥为seed。 表4 AudioInputBody 参数 是否必选 参数类型 描述 url 是 String 音频url地址。 language 否 String 支持检测的音频语言。可选值为zh:中文。 不传该参数表示默认为zh。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 最小长度:2 最大长度:64 result ImageDetectionResult object 调用成功时表示调用结果。 调用失败时无此字段。 表6 ImageDetectionResult 参数 参数类型 描述 suggestion String 审核结果是否通过。 block:包含敏感信息,不通过 pass:不包含敏感信息,通过 review:需要人工复检 category String 检测结果的一级标签。 支持category列表如下: terrorism: 暴恐 porn: 色情 image_text: 图文审核 details Array of ImageDetectionResultDetail objects 检测详情。 ocr_text String 图文审核检测出的文本,只有在category参数配置image_text且检测出文本时展示该字段。 表7 ImageDetectionResultDetail 参数 参数类型 描述 suggestion String 审核结果是否通过。 block:包含敏感信息,不通过 pass:不包含敏感信息,通过 review:需要人工复检 category String 检测结果的一级标签。 支持category列表如下: terrorism: 暴恐 porn: 色情 image_text: 图文审核 confidence Float 置信度,可选值在0-1之间,值越大,可信度越高。 face_location FaceLocationDetail object 人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。 例如:[207,522,340,567],207代表的是左上角的横坐标,522代表左上角的纵坐标,340代表的是右下角的横坐标,567代表的是右下角的纵坐标。 qr_location QRLocationDetail object 二维码位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。 例如:[207,522,340,567],207代表的是左上角的横坐标,522代表左上角的纵坐标,340代表的是右下角的横坐标,567代表的是右下角的纵坐标。 qr_content String 图片中二维码指向的链接,当请求参数categories中包含image_text时存在。 segments Array of OCRTextDetail objects image_text场景下命中的文本片段。 label String 识别的详细标签。 表8 FaceLocationDetail 参数 参数类型 描述 top_left_x Integer 检测出人脸的左上角横坐标。 top_left_y Integer 检测出人脸的左上角纵坐标。 bottom_right_x Integer 检测出人脸的右下角横坐标。 bottom_right_y Integer 检测出人脸的右下角纵坐标。 表9 QRLocationDetail 参数 参数类型 描述 top_left_x Integer 检测出的二维码左上角横坐标。 top_left_y Integer 检测出的二维码左上角纵坐标。 bottom_right_x Integer 检测出的二维码右下角横坐标。 bottom_right_y Integer 检测出的二维码右下角纵坐标。 表10 OCRTextDetail 参数 参数类型 描述 segment String 命中的风险片段 glossary_name String 命中的自定义词库名称。 命中自定义词库时,才会返回当前字段。 状态码: 400 表11 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 最小长度:8 最大长度:36 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 成功响应示例 { "request_id" : "53f9719c3730d1169e47403d5c8a9473", "result" : { "category" : "porn", "details" : [ { "category" : "porn", "confidence" : 0.9934315, "label" : "sexy_female", "suggestion" : "review" }, { "category" : "porn", "confidence" : 0.99798274, "label" : "intimacy", "suggestion" : "review" } ], "suggestion" : "review" } } 状态码: 400 失败响应示例 { "error_code" : "AIS.0402", "error_msg" : "The image format is not supported." }
  • 请求示例 “endpoint”即调用API的请求地址,不同服务不同区域的endpoint不同,具体请参见终端节点。 例如,服务部署在“华北-北京四”区域的“endpoint”为“moderation.cn-north-4.myhuaweicloud.com”,请求URL为“https://moderation.cn-north-4.myhuaweicloud.com/v3/{project_id}/moderation/image”,“project_id”为项目ID,获取方法请参见获取项目ID。 使用图片的BASE64编码,分析并识别用户上传的图像内容是否有敏感内容,事件类型为头像,检测场景为涉黄,暴恐。 POST https://{endpoint}/v3/{project_id}/moderation/image { "event_type" : "head_image", "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAA...", "categories" : [ "porn", "terrorism" ], "image_text_config" : { "black_glossary_names" : [ "test" ] } } 使用图片的url,分析并识别用户上传的图像内容是否有敏感内容,事件类型为头像,检测场景为涉黄,暴恐。 POST https://{endpoint}/v3/{project_id}/moderation/image { "event_type" : "head_image", "url" : "https://bucketname.obs.myhwclouds.com/ObjectName1", "categories" : [ "porn", "terrorism" ], "image_text_config" : { "black_glossary_names" : [ "test" ] } } 使用biz_type请求 POST https://{endpoint}/v3/{project_id}/moderation/image { "url" : "https://bucketname.obs.myhwclouds.com/ObjectName1", "biz_type" : "test-type" }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全