华为云用户手册

  • 视频加密 视频加密是指采用HLS AES-128标准协议对转码后的HLS视频内容进行加密。 安全级别较高,终端兼容性好。 支持在转码同时对视频内容进行加密。 对转码后的HLS视频内容进行加密处理时,您需注意以下事项: 输入的IV必须是安全随机数,且长度为128bit。 输入的Key必须是安全随机数生成的,且长度为128bit。 密钥服务器需对终端获取密钥的请求进行身份校验,并且开启加密传输,防止密钥泄漏。 为不同的转码请求设置不同的IV向量,避免因部分文件的IV和密钥泄漏而影响其它文件。
  • 个人数据说明 使用个人数据的场景 视频转码、转封装处理的音视频文件。 用户下发视频截图任务,截图后图片存储于用户自有OBS桶中。 收集的个人数据项 媒体处理 的音视频文件。 视频截图。 收集的来源和方式 最终用户访问。 媒体处理过程中,媒体处理服务从视频文件中获取。 使用的目的以及安全保护措施 用于视频转码处理,转码后文件存储到用户OBS桶。 存储在用户自有OBS桶中,用户可自行处理转码后文件,且用户可以根据实际需求配置OBS桶的安全机制。 截图后文件存储到用户OBS。 存储在用户自有OBS桶中,用户可自行处理截图文件,且用户可以根据实际需求配置OBS桶的安全机制。 存留期限与存留策略 系统缓存,异常场景下存留最大不超过24小时。 系统缓存,异常场景下存留最大不超过24小时。 销毁方式 系统自动删除缓存。 系统自动删除缓存。 导出方式 用户自行从OBS桶中下载导出。 用户自行从OBS桶中下载导出。 导出指导 请参见OBS用户指南导出。 请参见OBS用户指南导出。
  • 与其他云服务的关系 若您需要使用 消息通知 、权限管理、音视频文件存储等功能,您还需要开通其它依赖服务,如表1所示。 表1 与其他云服务关系 交互功能 相关服务 位置 在控制台配置消息通知时勾选 SMN 主题 消息通知服务(Simple Message Notification,SMN) 创建主题 添加订阅 设置主题策略 通过 IAM 服务实现管理用户以及用户组 统一身份认证 服务(Identity and Access Management, IAM) 创建用户组并授权 创建IAM用户 使用 对象存储服务 存储并管理音视频文件 对象存储服务(Object Storage Service,OBS) 创建桶 上传文件
  • 数据保护技术 MPC通过多种数据保护手段和特性,保障存储在MPC中的数据安全可靠。 表1 表1 MPC的数据保护手段和特性 数据保护手段 简要说明 详细介绍 传输加密(HTTPS) MPC支持HTTP和HTTPS两种传输协议,为保证数据传输的安全性,推荐您使用更加安全的HTTPS协议。 构造请求 数据冗余存储 OBS采用Erasure Code(EC,纠删码)算法做数据冗余,不是以副本的形式存储。在满足同等可靠性要求的前提下,EC的空间利用率优于多副本。 OBS创建桶时支持选择数据冗余存储策略,选择多AZ存储时,数据冗余存储在同区域的多个AZ。当某个AZ不可用时,仍然能够从其他AZ正常访问数据,适用于对可靠性要求较高的数据存储场景。 创建多AZ桶 数据完整性校验(MD5) 对象数据在上传下载过程中,有可能会因为网络劫持、数据缓存等原因,存在数据不一致的问题。MPC提供通过计算MD5值的方式对上传下载的数据进行一致性校验。 数据一致性校验 跨区域复制 跨区域复制是指通过创建跨区域复制规则,将一个桶(源桶)中的数据自动、异步地复制到不同区域的另外一个桶(目标桶)中。跨区域复制能够为用户提供跨区域数据容灾的能力,满足用户数据复制到异地进行备份的需求。 跨区域复制介绍和配置方法 敏感操作保护 MPC控制台支持敏感操作保护,开启后执行删除媒资等敏感操作时,系统会进行身份验证,进一步保证MPC配置和数据的安全性。 敏感操作保护介绍 用户敏感数据保护 MPC提供服务所必须的用户个人敏感信息,经过加密存储在服务内部,确保不存在泄露风险。 - 父主题: 安全
  • 审计与日志 审计 云审计 服务(Cloud Trace Service, CTS ),是华为 云安全 解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后,CTS可记录SecMaster的管理事件和数据事件用于审计。 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 日志 查询 出于分析或审计等目的,用户开启了云审计服务后,系统开始记录SecMaster资源的操作。云审计服务管理控制台保存最近7天的操作记录。 关于SecMaster云审计日志的查看,如图1所示。 图1 查询日志 父主题: 安全
  • 数据保护技术 SecMaster通过多种数据保护手段和特性,保证通过SecMaster的数据安全可靠。 表1 SecMaster的数据保护手段和特性 数据保护手段 简要说明 静态数据保护 SecMaster通过敏感 数据加密 保证用户流量中敏感数据的安全性。 传输中的数据保护 微服务间数据传输进行加密,防止数据在传输过程中泄露或被篡改。用户的配置数据传输采用安全协议HTTPS,防止数据被窃取。 数据完整性校验 SecMaster接入云服务告警、漏洞和基线等时,有数据完整性校验。 SecMaster核心数据面进程启动时,配置数据执行可靠事件模式确保数据完整性(网络抖动、延迟、配置数据重发&重试等场景)。 数据隔离机制 租户区与管理面隔离,租户的所有操作权限隔离,不同租户间的策略、日志等数据隔离。 数据销毁机制 考虑到残留数据导致的信息泄露问题,华为云根据客户等级设定了不同的保留期时长,保留期到期仍未续订或充值,存储在云服务中的数据将被删除,云服务资源将被释放。SecMaster对云服务自动感知并在保留期到期后释放资源。 同时,SecMaster服务充分尊重用户隐私,遵循法律法规,不会采集和存储任何用户隐私数据。更多隐私数据使用和保护问题,请参考隐私政策声明。 父主题: 安全
  • 服务韧性 华为云SecMaster当前主要部署在国内,已部署数据中心都处于正常运营状态,无一闲置。数据中心互为灾备中心,如一地出现故障,系统在满足合规政策前提下自动将客户应用和数据转离受影响区域,保证业务的连续性。为了减小由硬件故障、自然灾害或其他灾难带来的服务中断,华为云SecMaster提供灾难恢复计划。 当发生故障时,SecMaster的五级可靠性架构支持不同层级的可靠性,因此具有更高的可用性、容错性和可扩展性。 华为云SecMaster当前主要部署在国内,并在多个分区部署,同时SecMaster的所有管理面、引擎等组件均采用主备或集群方式部署。 父主题: 安全
  • 安全编排 SecMaster的安全编排功能可以针对云上安全事件提供安全编排剧本,实现安全事件的高效、自动化响应处置。其主要功能如下: 剧本管理:内置自动响应的剧本,支持按需定义扩展。 编写剧本的过程就是将安全运营流程和规程转换为剧本,并在剧本中将各种应用编排到一起的过程,也是将人读安全运营流程转换为机读工作流的过程。 流程管理:绘制流程图响应剧本触发。 资产管理:支持对关键资产、安全资产等进行统一管理呈现。 实例管理:支持对运行的实例进行监控管理及记录查看。 安全事件自动化响应:对需要处理的安全事件(incidence)以及可疑事件,通过安全编排实现自动化处置及事件调查。 安全编排设置方法请参见安全编排。 父主题: 安全
  • 为什么选择 安全云脑 一键安全合规:一键生成遵从报告,华为积累的全球安全合规经验服务化,帮助用户快速实现云上业务安全/隐私保护遵从。 一屏全面感知:采集各类安全服务的告警事件,并进行大数据关联、检索、排序,全面评估安全运营态势,支持大屏展示安全运营动态。 一云全局分析:结合华为云积累的每日数亿威胁情报定位威胁,多维关联分析,消除无效告警、识别潜在高级威胁。 一体全程处置:服务内置多种处理剧本,实现99%以上的安全事件分钟级自动化响应。 更多安全云脑产品优势请参见产品优势。
  • 监控安全风险 SecMaster已对接 云监控服务 (Cloud Eye, CES ),可以通过管理控制台,查看SecMaster的相关运行指标,及时了解SecMaster运行状况。CES服务是华为云为用户提供一个针对各种云上资源的立体化监控平台,用户通过 云监控 服务可以全面了解云上的资源使用情况、业务的运行状况,并及时收到异常告警做出反应,保证业务顺畅运行。 SecMaster自身作为云上安全运营作战平台,可以接入其他云服务的安全告警,按照告警类型和等级统一维度呈现,可以准确实时监控云上威胁攻击、检测您资产中的安全告警事件;定义威胁告警通知,设置每日定时告警通知和实时告警通知,通过接收消息通知及时了解威胁风险。定义监控的威胁名单、告警类型、告警级别等,选择性呈现关注的威胁告警。帮助用户及时了解安全状况,从而起到预警作用。 CES的详细介绍和开通配置方法,请参见CES快速入门。 表1 监控 事件来源 事件名称 事件级别 事件说明 处理建议 事件影响 SYS.SecMaster 独享引擎创建失败 重要 一般是由于底层资源不足等原因导致。 提交工单让运维在后台协调资源再重试。 无法创建独享引擎 SYS.SecMaster 独享引擎运行异常 紧急 一般是由于流量过大或者恶意流程,插件导致。 排查流程,插件执行是否占用资源过多。 查看实例监控,短期内是否实例数量暴增。 无法执行实例 SYS.SecMaster 剧本实例执行失败 一般 一般是由于剧本,流程配置出错导致。 通过实例监控查看失败原因,修改剧本,流程配置。 无 SYS.SecMaster 剧本实例突增 一般 一般是由于剧本,流程配置出错导致。 通过实例监控查看突增原因,修改剧本,流程配置。 无 SYS.SecMaster 日志消息突增 重要 上游服务产生大量日志,导致消息快速增加。 需要排查上游服务业务是否正常。 无 SYS.SecMaster 日志消息突减 重要 上游服务产生日志突然变小。 需要排查上游业务是否正常 无 告警监控相关内容详细操作请参见: 漏洞管理 基线检查 安全报告 父主题: 安全
  • 身份认证与访问控制 SecMaster对接了统一身份认证服务(Identity and Access Management,IAM)服务。SecMaster租户身份认证与访问控制通过IAM权限控制。 统一身份认证(Identity and Access Management,简称IAM)是华为云提供权限管理的基础服务,可以帮助SecMaster服务安全地控制访问权限。通过IAM,可以将用户加入到一个用户组中,并用策略来控制他们对SecMasterr资源的访问范围。SecMaster权限可以通过细粒度定义允许和拒绝的访问操作,以此实现SecMaster资源的权限访问控制。 父主题: 安全
  • 计费项 安全云脑基础版 免费体验 。标准版、专业版按选购的资产配额数和增值包计费,其中增值包功能为可选增值项目。 表1 计费项说明 版本 计费模式 计费项 计费说明 基础版 包周期(包年/包月) 资产配额 免费体验,不计费。 标准版 包周期(包年/包月) 资产配额 按购买的资产配额数计费。 购买时长 提供包周期的购买模式。 专业版 包周期(包年/包月) 资产配额 按购买的资产配额数计费。 购买时长 提供包周期的购买模式。 按需 资产配额 即开即停,按小时结算。 增值包 包周期(包年/包月) 安全大屏 提供包周期的购买模式。 增值项。若有安全大屏展示、智能检索分析或安全编排与响应需求,您需在已购买资产配额基础上,额外付费购买。 智能分析配额 安全编排 按需 安全大屏 按实际使用时长计费。 增值项。若有安全大屏展示需求,您需在已购买资产配额基础上,额外付费购买。 智能分析配额 按实际使用流量计费。 增值项。若有智能检索分析需求,您需在已购买资产配额基础上,额外付费购买。 安全编排 按实际使用次数计费。 增值项。若有安全编排与响应需求,您需在已购买资产配额基础上,额外付费购买。 说明: 增值包为标准版和专业版额外选购付费项目,不支持单独购买,如需使用,请先购买标准版或专业版。 安全云脑(标准版和专业版)增值包中的智能分析和安全编排含有赠送配额/次数可以免费使用。如果赠送配额/次数不足,无法满足业务需求,请单独开通增值包功能。具体赠送情况如下: 智能分析:标准版 60MB/E CS /天、专业版 120MB/ECS/天 安全编排:标准版 500次/ECS/天、专业版 10000次/ECS/天
  • 变更配置 变更资产配额 当您的资产数量增加,可在当前计费模式内增加资产配额数,不支持减少配额数。 开通增值包功能 当您需要安全大屏、智能分析、安全编排功能时,可在原有资产配额基础上,追加“安全大屏”、“智能分析”、“安全编排”功能。 退订 若购买安全云脑后,需停止使用,请执行退订操作。 标准版仅支持通过包周期计费模式进行购买。 不支持部分配额购买标准版和专业版。 增值包中的“安全大屏”、智能分析、“安全编排”为标准版和专业版额外选购付费项目,如需使用,请先购买标准版或专业版。
  • 续费 包周期购买的版本到期后,您可以单击“已购资源”页面中对应region栏的“续费”,跳转至续费管理页面完成续费,延长使用期。 为避免版本到期未及时续费,导致安全风险,建议开通自动续费。开通自动续费后,系统将根据配置自动续费,无需手动操作。 按需计费是按小时计费,请确保账户余额充足,及时为账户充值。在账户余额充足的前提下,将持续为您提供防护服务,不影响使用。 更多续费信息(例如自动续费、导出续费清单、变更资费等),请参见续费管理。
  • 与标签管理服务的关系 标签管理服务(Tag Management Service,简称TMS)是一种快速便捷将标签集中管理的可视化服务,方便用户通过标签标识管理工作空间实例。 表1 标签管理服务支持的SecMaster操作列表 操作名称 资源类型 事件名称 查询资源实例列表 Workspace listResourceInstance 查询资源实例数量 Workspace countResourceInstance 批量查询资源标签 Tag batchTagResources 批量删除资源标签 Tag batchUntagResources 查询项目标签 Tag listProjectTag 更新标签值 Tag updateTagValue 查询资源标签 Tag listResourceTag
  • 与安全服务的关系 安全云脑从主机安全(Host Security Service,HSS)、 Web应用防火墙 (Web Application Firewall,WAF)、Anti-DDoS流量清洗(Anti-DDoS)等安全防护服务中获取必要的安全事件记录,进行大数据挖掘和机器学习,智能AI分析并识别出攻击和入侵,帮助用户了解攻击和入侵过程,并提供相关的防护措施建议。更多说明请参见安全云脑与其他安全服务之间的关系与区别。
  • 图像显示 表4 图像显示功能清单 功能 说明 OSD配置 - 用户可以在视频画面上显示时间和文字叠加的效果。可以理解为视频水印。支持配置最多6项OSD水印显示。并且支持调整水印字体大小。 图像套餐 图像套餐 图像套餐为一套图像参数的合集,可通过切换图像套餐或修改图像套餐中参数来达到更改图像参数: 支持使用/复制系统定义图像套餐; 支持新增/修改/删除/使用/复制用户自定义图像套餐,用户最多可自定义8个。 图像调节 支持调节图像基础参数:亮度、饱和度、对比度、锐度。 日夜切换 支持切换昼夜模式,通过调整昼夜模式能帮助摄像机适应低照度条件,体现更高的光灵敏度。 曝光/背光 曝光:支持切换曝光模式,并且可根据被拍摄画面的曝光值手动/自动调整快门速度与增益,提高画面质量。背光:当曝光模式为自动曝光时,支持切换背光模式: 宽动态:在明暗反差过大的场合,有效解决背景过亮或前景太暗的情况。 强光抑制:有效抑制强光点直接照射问题,把强光部分弱化,把暗光部分亮化,达到光线平衡。 背光补偿模式:有效补偿摄像机在逆光环境下拍摄时画面主体黑暗的缺陷。 背光自适应:可以有效补偿摄像机在逆光环境下拍摄时画面主体黑暗的缺陷。 聚焦 支持切换相机的聚焦模式与聚焦补偿模式,并且可配置最小聚焦距离,提高图像清晰度。 白平衡模式 支持切换白平衡模式及调整红色增益和蓝色增益。在不同的光照环境中,物体颜色会因投射光线颜色产生变化,通过选择白平衡模式中红色增益和蓝色增益的值来修正颜色误差。 图像增强 在多种异常场景下可增强图像效果: 支持切换透雾模式,在有雾环境下可以使画面更清晰。 支持切换电子防抖模式,在设备抖动时保持大部分画面相对稳定,但会损失部分画面。 支持切换降噪模式,在嘈杂环境下提升语音清晰度。 支持切换伽马矫正,用于调节图像对比度,改善对比度的同时,可避免引入更多新的噪点。 支持切换畸变矫正,在摄像机的图像画面发生一定的几何畸变的情况下使画面更准确。 补光灯控制 支持切换智能红外模式,避免图像过曝。 支持调节内置灯(近光灯/中光灯/远光灯)的亮度与开关灯时间。 图像套餐计划 年度计划 支持针对每月的不同的时间(00:00-24:00)制定年度图像套餐应用计划。 当前时间到达配置时间时,图像套餐自动切换为年度计划配置的套餐。 可选套餐来源于“图像套餐”,新增可选图像套餐、更改图像套餐参数时,需要前往图像套餐配置。 支持画框、复制、删除、撤销、恢复、清空等操作。 同一时间内只能执行一种套餐,不选择、不设置时为默认套餐。 昼夜计划 支持针对日夜不同场景制定年度图像套餐应用计划。 当通过光线发现周边场景发生变化时,将自动切换为白衣庵套餐/夜晚套餐。 可选套餐来源于“图像套餐”,新增可选图像套餐/更改图像套餐参数时,需要前往图像套餐配置。 支持配置白天套餐、夜晚套餐、光学透雾模式。 同一时间内只能执行一种套餐。 当选择套餐内日夜切换不是自动模式时,无法生效。
  • 音视频编码 表6 音视频编码功能清单 功能 说明 视频编码参数 视频编码基础参数 支持切换码流类别:可以根据实际使用情况选择码流组合; 支持切换镜像模式:可对视频画面做上下左右颠倒处理; 支持开启走廊模式:可对视频画面进行90度旋转,得到9:16或者3:4等横纵比。 支持配置全帧率:可更改摄像机最大支持帧率,码流帧率最大值将小于全帧率。 码流参数 支持切换编码协议:可更改编码协议为“H.264”、“H.265”、“MJPEG”. 支持开启智能编码能力与配置智能级别:智能编码可帮助摄像机自适应场景,降低码率大小,节省存储空间;智能级别越高,降低码率效果越显著。 支持开启多slice编码能力:将视频流分成多段,每段的编码过程是相互独立的,提升编码和解码的性能。 支持切换编码复杂度:可更编码复杂度为“Base Profile”、“Main Profile”、“High Profile”,编码压缩性能依次升高,硬件设备解码性能要求也依次升高。 支持切换分辨率:可更改视频分辨率,分辨率越高,图像越清晰,占用的带宽越大。 支持切换码率类型:可切换码率类型为“变码率”或者“定码率”,并配置对应的码率上限、码率值。 支持切换图像质量:图像质量越好,占用带宽越大。 支持配置帧率:可更改每秒显示的帧数,帧率越高,图像越真实,占用带宽越大。 支持配置I帧间隔:可更改I帧(每个画面组的第一个帧)的时间间隔,I帧间隔越小,视频质量越高,占用带宽越大。 支持开启分层编码能力:编码时可以输出多层码流(基本层和增强层),同时保证视频流畅度和视频质量,提升编码和解码性能。 支持配置JPEG质量:可调整图像质量,JPEG质量数值越大,视频质量越好,占用带宽越大。 支持切换动态码率模式与动态帧率模式:当触发告警时,摄像机会自动采用动态码率/帧率值,告警结束后重新返回在码流中设置的码率/帧率值。 音频编码参数 - 支持切换音频编码格式:可根据使用场景更改编码格式为“G.711u”、“G.711a”、“G.726”、“OPUS”、“AAC”; 支持切换输入端口类型:可更改音频流接入端口的类型为“Mic-in”、“Line-in”、“Double-Mic-in”; 支持配置输入、输出音量; 支持配置音频码率:音频码率值越大,音质越好,占用带宽越大; 支持配置音频采样率:录音设备在一秒钟内对声音信号的采样次数,采样率越高声音的还原就越真实越自然; 支持开启环境噪声过滤:将周围环境的噪声减小,使有效声音更清晰; 支持开启音频自动增益:提升音频质量; 支持开启回声消除:可消除录制的语音数据中的AO设备播放的声音,提升音频质量; 支持开启二次降噪:用于去除外界噪声,提升音频质量; 支持开启抗削波:用于控制输出信号电平,防止削波(破音)。
  • 告警配置 表5 告警配置功能清单 功能 说明 联动策略总开关 - 支持配置“告警联动策略”启用开关,控制所有事件的“告警联动策略”。 当总开关未开启时,单个告警配置开启时也不会生效; 设置对应的告警联动策略前,必须开启对应的开关。 普通告警 布防计划 配置告警上报计划,相关告警仅在计划时间内生效并上报。 支持自定义计划,支持画框、复制、删除、撤销、恢复、清空等操作; 支持四种通用计划:全天候、工作日、周末、工作时间。 告警联动 配置告警上报的时间间隔与方式/形式。 支持配置告警间隔:针对事件类告警,系统按配置的告警间隔对业务上报的告警进行时间过滤,确保连续上报的告警发生时间不小于告警间隔。 支持配置自动恢复时间:针对故障类告警,若故障在自动恢复时间内未收到告警消除消息,系统将自动消除告警。 支持配置告警联动策略:可选择告警上报/形式的方式,仅告警策略的联动状态为生效时告警才会通过该策略上报。
  • 智能配置 摄像机目标智能应用场景如表1所示,操作指导参见目标智能。 表1 目标智能应用场景 功能 说明 目标抓拍 对设定区域中目标进行抓拍,实时显示目标信息。以及发送目标图片。 口罩告警 对设定区域中目标是否佩戴口罩进行检测并告警。 目标统计 统计设定区域内越线的人流量,超过阈值时生成告警。 摄像机智能行为分析应用场景如表2所示,操作指导参见行为分析智能配置。 表2 行为分析应用场景 功能 说明 越线检测 检测人员从某个设定方向越过设定边界的事件并告警。 入侵检测 检测人员在设定区域内出现的事件并告警。 区域进入 检测人员进入设定区域内的事件并告警。 区域离开 检测人员离开设定区域内的事件并告警。 快速移动 检测目标奔跑追逐事件,达到设定条件(通过配置灵敏度来设定条件)后立即告警。 徘徊检测 检测人员在设定区域内徘徊、滞留超过设定时间的事件并告警。 遗留检测 检测到设定区域内有物品遗留的事件并告警。 移走检测 检测到设定区域内有物品移走的事件并告警。 周界全局配置 支持配置周界所有算法的元数据处理、告警处理 、目标尺寸设置、最大目标数设置、检测灵敏度等基础能力。 备注 : 需要开启周界全局开关才可支持算法配置; 单个设备最多支持画10个框,单个告警最多支持画4个框 ;最多支持10点成框; 单个设备最多支持画5条; 布防计划支持自定义计划与四种通用计划(全天候、工作日、周末、工作时间),算法仅在计划时间范围内生; 告警联动中,仅告警策略的联动状态为生效时,告警才会通过该策略上报。 摄像机智能态势分析应用场景如表3所示,操作指导参见态势分析智能配置。 表3 态势分析应用场景 功能 说明 过线统计 统计设定区域内越线的人流量,超过阈值时生成告警。 人群密度 统计设定区域内人数,超过阈值时生成告警。 排队长度 统计设定区域内排队人数,总排队时长超过阈值时生成告警。 离岗检测 统计设定区域内在岗人数,少于设定人数且离岗时间超过阈值时生成告警。 热区分析 统计设定区域内驻足人次、驻足均时;人员进出时间、驻足时间。 热度图 统计设定区域内一定时间内的人群分布,生成报告。
  • 设备版本限制 远程配置功能与设备10.0.0版本配套,仅少数其他版本支持部分功能,设备配套关系表如下: 表1 设备配套关系 组网场景 NVR/IVS设备版本 SDC设备版本 适用功能 SDC直连 - SDC 9.0.0.LG0001 SDC 9.0.0.LG0002 SDC 9.0.0.SPC307 SDC 10.0.0及以上 全部 SDC 10.0RC11.SPC100 仅不支持视频编码参数 其他 不支持 NVR/IVS+SDC透传 NVR 9.0.0 SPC6及以上版本 或 IVS 9.1.0及以上版本 SDC 9.0.0.LG0001 SDC 9.0.0.LG0002 SDC 9.0.0.SPC307 SDC 10.0.0及以上 全部 其他 不支持 其他 - 不支持
  • IdcardResult 身份证 图像文字识别 结果结构体。 表1 结构体说明 参数 类型 描述 name String 身份证上识别的名称。 number String 身份证号。 sex String 性别。 birth String 出生日期。 ethnicity String 民族。 address String 地址。 issue String 发证机关。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 表2 VideoResult 参数 参数类型 描述 alive Boolean 是否是活体。 actions Array of ActionsList objects 动作列表。 picture String 检测出最大人脸的图片base64。 表3 ActionsList 参数 参数类型 描述 confidence Double 置信度,取值范围0~1。 action Integer 动作编号,取值范围:[1,2,3,4],其中: 1:左摇头 2:右摇头 3:点头 4:嘴部动作 父主题: 公共数据结构
  • 调用API获取项目ID 获取项目ID的接口为“GET https://{endpoint}/v3/projects”,其中“{endpoint}”为IAM的终端节点。接口的认证鉴权请参见认证鉴权。 响应示例如下,例如, 人证核身 服务部署的区域为“cn-north-4”,响应消息体中查找“name”为“cn-north-4”,其中“projects”下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22https://support-intl.huaweicloud.com/zh-cn/devg-apisign/api-sign-provide.htmlcd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 约束与限制 只支持“华北-北京一”、“华北-北京四”区域。 只支持中国大陆身份证的识别。 只支持JPG格式,图片中人像需无遮挡。 图像数据,base64编码,要求base64编码后大小不超过4MB。 图像各边的像素大小在300到8000px之间。 图像中身份证区域有效占比超过15%,保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证要求水平放置。 目前支持检测视频文件,或视频的Base64编码,不支持直接检测视频流,需要用户客户端自己获取视频流并保存成文件,然后调用活体检测接口。 视频文件大小不超过8MB,建议客户端压缩到200KB~2MB。 限制视频时长1~15秒。 建议帧率10fps~30fps。 封装格式:mp4、avi、flv、webm、asf、mov。 视频编码格式:h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 父主题: 使用前必读
  • 申请服务 正式使用服务之前,必须先申请开通服务,下面是相关服务申请的步骤。 申请人证核身服务之前,必须先申请华为云账号。 首次使用服务时,需要先申请开通该服务。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示IVS.0015报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。 登录人证核身服务控制台。 选择需要使用的服务,在操作列单击“开通服务”。 图1 开通服务 服务开通成功后,开通状态显示“已开通”。 父主题: 如何调用API
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 说明 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的endpoint不同,您可以从地区和终端节点获取。 例如IVS服务在“华北-北京四”区域的“endpoint”为“ivs.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,也即API访问路径。 从具体API的URI模块获取,例如人证核身标准版(三要素)API的“resource-path”为“/v2.0/ivs-standard”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如,您需要在“华北-北京四”区域调用人证核身标准版(三要素)API,则需使用“华北-北京四”区域的Endpoint(ivs.cn-north-4.myhuaweicloud.com),并在标准版(三要素)的URI部分找到resource-path(/v2.0/ivs-standard),拼接起来如下所示。 https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 人证核身标准版(三要素)的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于人证核身标准版(三要素)接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...Request Body:{ "meta": { "uuid": "user_defined" }, "data": { "req_data": [ { "idcard_image1": "/9j/4AAQSkZJRgABAgEASA...", "idcard_image2": "/9j/4AAAAABQSkZJRgABAgEASB...", "face_image": "/9j/4BBQSkZJRgABAgEASB..." } ] }} 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token请参考认证鉴权。 添加消息头后的请求如下所示。 POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standardContent-Type: application/jsonx-auth-token: MIIaBgYJKoZIhvcNAQcC……
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于人证核身标准版(三要素)接口,返回如下消息体。 { "meta": { "uuid": "user_defined" }, "result": { "service_name": "ivs-standard", "count": 1, "resp_data": [ { "verification_result": "valid", "verification_message": "Successful certification", "verification_code": 1000, "similarity": "88.43", "idcard_result": { "name": "张三", "sex": "男", "birth": "2000-03-06", "ethnicity": "汉", "address": "XX省XX市XX区XX街道XX号", "number": "610XXXXXXXXXXXXXXX" } } ] }} 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "IVS.0003", "error_msg": "Some necessary request parameters in req_data is null."} 其中,error_code表示错误码,error_msg表示错误描述信息。
共100000条