华为云用户手册

快速部署 本章节主要帮助用户快速部署Web网站基础安全防护解决方案。 表1 参数填写说明 参数名称 类型 是否可选 参数解释 默认值 domain string 必填 指定要保护的域名。 空 address string 必填 客户端访问的 Web 服务器的 IP 地址或域名。 空 web_port string 必填 Web 服务器使用的端口号。取值范围为 0 到 65535。 80 登录华为云解决方案实践，选择“Web网站基础安全防护”解决方案。数据中心下拉菜单可以选择需要部署的区域，单击“一键部署”，跳转至解决方案创建堆栈界面。 图1 解决方案实施库 在选择模板界面中，单击“下一步”。 图2 选择模板 在配置参数界面中，参考表1完成自定义参数填写，单击“下一步”。 图3 配置参数 在资源栈设置页面中，权限委托选择“rf_admin_trust”(可选），单击“下一步”。 图4 资源栈设置 在配置确认页面中，单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中，自定义填写执行计划名称，单击“确定”。 图6 创建执行计划 待执行计划状态为“创建成功，待部署”后，单击“执行”，并且在弹出的执行计划确认框中单击“部署”。 图7 执行计划 图8 执行计划确认 （可选）如果计费模式选择“包年包月”，在余额不充足的情况下（所需总费用请参考表1）请及时登录费用中心，手动完成待支付订单的费用支付。 等待解决方案自动部署。部署成功后，单击“事件”，回显结果如下: 图9 资源创建成功 父主题： 实施步骤

约束与限制 该解决方案部署前，需 注册华为账号 并开通华为云，完成实名认证，且账号不能处于欠费或冻结状态。如果计费模式选择“包年包月”，请确保账户余额充足以便一键部署资源的时候可以自动支付；或者在一键部署的过程进入费用中心，找到“待支付订单”并手动完成支付。 同一账号在同一个大区域（例如华北区域）只能选择一个 Web应用防火墙 服务版本。 如果涉及WAF的退订与重新购买，请确保重新购买的WAF与原WAF在同一区域，如果不在同一区域，原WAF中配置的数据将不能保存。此时，您需要在购买WAF后，将防护域名重新接入WAF，并根据防护需求为域名配置相应的防护规则，详细说明请参见Web防火墙官方帮助文档。 使用中国大陆节点服务器部署的Web网站，您需要注册域名，并在开通网站前按照工信部要求办理网站备案，以确保您的网站可以通过域名正常访问。华为云支持一站式完成域名注册、实名认证、网站备案和网站解析等操作，详细操作请参考 域名注册服务 Domains流程指引。

方案架构 该解决方案基于华为云Web应用防火墙 WAF构建，可以帮助企业网站业务流量进行多维度检测和防护，全面避免网站被黑客恶意攻击和入侵。 图1 方案架构图 该解决方案部署如下资源： 创建一台云模式入门版Web应用防火墙 WAF，用于对HTTP请求进行检测，保证Web服务安全稳定。 在Web应用防火墙WAF上一键添加防御域名，提高配置域名的便利性，构建风险全面可控的网站安全架构，保障网站业务连续可用。

资源和成本规划 该解决方案主要部署如下资源，不同产品的花费仅供参考，具体请参考华为云官网价格，实际以收费账单为准： 表1 资源和成本规划（按需计费） 华为云服务 配置示例 每月预估花费 弹性云服务器 E CS 区域：华北-北京四 计费模式：按需计费 规格：X86计算 | ECS | s6.medium.2 | 1vCPUs | 2GiB 镜像：CentOS 7.6 64bit 系统盘：高IO | 40GB 购买量：1 0.1896*24*30=136.512元 弹性公网IP EIP 按需计费（按带宽计费）：0.335元/5M/小时 区域：华北-北京四 计费模式：按带宽计费 线路：动态BGP 公网带宽：按带宽计费 带宽大小：5Mbit/s 购买量：1 0.335*24*30=241.2元 合计 - 377.712元 表2 资源和成本规划（包年包月） 华为云服务 配置示例 每月预估花费 弹性云服务器 ECS 区域：华北-北京四 计费模式：包年包月 规格：X86计算 | ECS | s6.medium.2 | 1vCPUs | 2GiB 镜像：CentOS 7.6 64bit 系统盘：高IO | 40GB 购买量：1 100.20元 弹性公网IP EIP 区域：华北-北京四 计费模式：包年包月 线路：动态BGP 公网带宽：按带宽计费 带宽大小：5Mbit/s 购买时长：1个月 购买量：1 115元 合计 - 215.2元

创建rf_admin_trust委托（可选） 进入华为云官网，打开控制台管理界面，鼠标移动至个人账号处，打开“ 统一身份认证 ”菜单。 图1 控制台管理界面 图2 统一身份认证菜单 进入“委托”菜单，搜索“rf_admin_trust”委托。 图3 委托列表 如果委托存在，则不用执行接下来的创建委托的步骤 如果委托不存在时执行接下来的步骤创建委托 单击步骤2界面中的“创建委托”按钮，在委托名称中输入“rf_admin_trust”，委托类型选择“云服务”，输入“ RFS ”，单击“下一步”。 图4 创建委托 在搜索框中输入“Tenant Administrator”权限，并勾选搜索结果，单击“下一步”。 图5 选择策略 选择“所有资源”，并单击“下一步“完成配置。 图6 设置授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功。 图7 委托列表

快速部署 本章节主要帮助用户快速部署该解决方案。 表1 参数填写说明 参数名称 类型 是否必填 参数解释 默认值 vpc_name String 必填 虚拟私有云名称，该模板新建VPC，不允许重名。取值范围：1-55个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 accessing-obs-through-nginx-demo secgroup_name Number 必填 安全组名称，该模板新建安全组，如果修改，请参考安全组规则修改（可选）。取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 accessing-obs-through-nginx-demo ecs_name String 必填 弹性云服务器名称，命名方式为{ecs_name}_ecs不允许重名。取值范围：1-60个字符，支持字母、数字、中文、下划线（_）、中划线（-）、英文句号（.）。 accessing-obs-through-nginx-demo ecs_flavor String 必填 弹性云服务器规格，具体请参考官网弹性云服务器规格清单选择。 s6.medium.2 ecs_password String 必填 弹性云服务器初始密码，创建完成后，请参考重置ECS实例密码进行密码修改。取值范围：长度为8-26位，密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种，密码不能包含用户名或用户名的逆序。管理员账户为root。 空 charging_mode String 必填 计费模式，默认自动扣费，取值为prePaid（包年包月）或postPaid（按需计费）。 postPaid charging_unit String 必填 包年包月。有效值为“year”或“month”。当charging_mode（计费模式）为prePaid时，此选项为必填项。 month charging_period String 必填 包年包月时长，当charging_unit取值为“year”,取值范围为1～3;取值为“month”,取值范围为1～9。当charging_mode（计费模式）为prePaid时，此选项为必填项。 1 bandwidth_size String 必填 弹性公网带宽大小，该模板计费方式为按带宽计费。取值范围：1-2,000Mbit/s。 5 obs_name String String 被代理的 对象存储服务 OBS名称。取值范围：3-63个字符，支持小写字母、数字、-（中划线）和.（英文句号）。 空 登录华为云解决方案实践，选择“通过Nginx反向代理访问OBS最佳实践”解决方案，单击“一键部署”，跳转至解决方案创建堆栈界面。 图1 解决方案实施库 在选择模板界面中，单击“下一步”。 图2 选择模板 在配置参数界面中，自定义填写堆栈名称，根据表1填写配置参数信息，单击“下一步”。 图3 配置参数 在资源栈设置页面中，权限委托选择“rf_admin_trust”（可选），单击“下一步”。 图4 高级配置 在配置确认页面中，单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中，自定义填写执行计划名称，单击“确定”。 图6 创建执行计划 图7 执行计划创建成功 单击“部署”，弹出执行计划提示信息，单击“执行”确认执行。 图8 执行计划确认 （可选）如果计费模式选择“包年包月”，在余额不充足的情况下（所需总费用请参考表2）请及时登录费用中心，手动完成待支付订单的费用支付。 等待解决方案自动部署。部署成功后，单击“事件”，回显结果如下: 图9 资源创建成功 父主题： 实施步骤

快速部署 本章节主要帮助用户快速部署该解决方案。 表1 表1 参数填写说明 参数名称 类型 是否必填 参数解释 默认值 vpc_name String 必填 虚拟私有云名称，该模板新建VPC，不支持重名。取值范围：1-60个字符，支持字母、数字、中文、下划线（_）、中划线（-）、英文句号（.）。 deploy-a-highly-available-postgresql-demo secgroup_name String 必填 安全组名称。取值范围：1-55个字符，支持字母、数字、中文、下划线（_）、中划线（-）、英文句号（.）。 deploy-a-highly-available-postgresql-demo ecs_name String 必填 弹性云服务器名称，不允许重名。取值范围：1-53个字符，支持字母、数字、中文、下划线（_）、中划线（-）、英文句号（.）。 deploy-a-highly-available-postgresql-demo ecs_flavor String 必填 弹性云服务器规格名称，具体请参考官网弹性云服务器规格清单。 s6.medium.2 ecs_password String 必填 弹性云服务器初始密码，创建完成后，请参考重置ECS实例密码登录ECS控制台修改密码。取值范围：长度为8-26位，密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种，密码不能包含用户名或用户名的逆序。管理员账户为root 空 system_disk_size number 必填 系统盘大小，以GB为单位，取值范围为40～1024，不支持缩盘。 40 data_disk_size number 必填 数据盘大小，以GB为单位，取值范围为10～32768。 100 charging_mode String 必填 计费模式，默认自动扣费，取值为prePaid（包年包月）或postPaid（按需计费），默认postPaid。 postPaid charging_unit String 选填 有效值为“year”或“month”。当charging_mode（计费模式）为prePaid时，此选项为必填项。 month charging_period number 选填 包年包月时长，当charging_unit取值为“year”,取值范围为1～3；当charging_unit取值为“month”,取值范围为1～9。当charging_mode（计费模式）为prePaid时，此选项为必填项。 1 postgresql_password String 必填 PostgreSQL的root用户密码，长度4-12位，密码至少大写字母、小写字母、数字和特殊字符（@%^-=）中的三种。参考修改PostgreSQL数据库默认用户postgres的密码，重置默认用户postgres的密码。 空 登录华为云解决方案实践，选择“快速部署高可用PostgreSQL”解决方案，数据中心下拉菜单可以选择需要部署的区域，单击“一键部署”，跳转至解决方案创建堆栈界面。 图1 解决方案实施库 在选择模板界面中,单击“下一步：配置参数。 图2 选择模板 在配置参数界面中，参考表1完成自定义参数填写，单击“下一步”。 图3 配置参数 在资源栈设置页面中，权限委托选择“rf_admin_trust”,单击“下一步”。 图4 资源栈设置 在配置确认页面中，单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中，自定义填写执行计划名称，单击“确定”。 图6 创建执行计划 待执行计划状态为“创建成功，待部署”后，单击“部署”，并且在弹出的执行计划确认框中单击“执行”。 图7 执行计划 图8 执行计划确认 （可选）如果计费模式选择“包年包月”，在余额不充足的情况下（所需总费用请参考表1）请及时登录费用中心，手动完成待支付订单的费用支付。 等待解决方案自动部署。部署成功后，单击“事件”，回显结果如下: 图9 资源创建成功 父主题： 实施步骤

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 meta Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 result result object 调用返回结果。 表7 Meta 参数 参数类型 描述 uuid String 唯一标识此次请求的ID，用户自定义，不超过64位。 表8 result 参数 参数类型 描述 service_name String 子服务名称。 count Integer 执行检测的数量，与resp_data字段对应。 resp_data Array of StandardRespDataByVideoAndNameAndId objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表9 StandardRespDataByVideoAndNameAndId 参数 参数类型 描述 verification_result String 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 verification_message String 审核校验信息，具体参考校验信息说明 verification_code Integer 审核校验代码，具体参考校验信息说明 similarity String 人像相识度。取值范围[0,100]，当入参detail为true时，取值范围为[0,1000]。 video_result VideoResult object 动作活体检测的检测结果。 表10 VideoResult 参数 参数类型 描述 alive Boolean 是否是活体。 actions Array of ActionsList objects 动作列表。 picture String 检测出最大人脸的图片base64。 表11 ActionsList 参数 参数类型 描述 confidence Double 置信度，取值范围0～1。 action Integer 动作编号，取值范围：[1,2,3,4]，其中： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求示例 使用身份证姓名、号码、人脸视频进行活体人证核验 POST https://{endpoint}/v2.0/ivs-standard { "meta" : { "uuid" : "user_defined" }, "data" : { "req_data" : [ { "verification_name" : "张三", "verification_id" : "44***********07", "video" : "/9j/4AAQSkZJRgABAgEASABIAAD...", "actions" : "1,3,2", "nod_threshold" : 10 } ] } }

响应示例 状态码： 200 OK { "meta" : { "uuid" : "user_defined" }, "result" : { "service_name" : "ivs-standard", "count" : 1, "resp_data" : [ { "verification_result" : "valid", "verification_message" : "Successful certification", "verification_code" : 1000, "similarity" : "65", "video_result" : { "alive" : true, "actions" : [ { "confidence" : 0.823, "action" : 1 }, { "confidence" : 0.823, "action" : 3 }, { "confidence" : 0.823, "action" : 2 } ], "picture" : "/9j/4AAQSkZJRgABAQEAYABgAAD/2w..." } } ] } } 状态码： 400 失败响应样例 { "error_code" : "IVS.0003", "error_msg" : "Some necessary request parameters in req_data is null." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String X-Auth-Token值获取方法请参见认证鉴权。 Enterprise-Project-Id 否 String 企业项目ID。IVS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用IVS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用IVS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用IVS服务，账单的企业项目会被分类到"default"中。 表2 请求Body参数 参数 是否必选 参数类型 描述 meta 是 Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 data 是 data object 请求消息的数据部分。 表3 Meta 参数 是否必选 参数类型 描述 uuid 否 String 唯一标识此次请求的ID，用户自定义，不超过64位。 表4 data 参数 是否必选 参数类型 描述 req_data 否 Array of StandardReqDataByVideoAndNameAndId objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表5 StandardReqDataByVideoAndNameAndId 参数 是否必选 参数类型 描述 verification_name 是 String 被验证人的姓名。 verification_id 是 String 被验证人的身份证号码。 video 是 String 现场拍摄人像视频数据，使用base64编码。 视频文件大小不超过8MB，建议客户端压缩到200KB~2MB。要求base64编码后大小不超过10M。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式：h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 actions 是 String 动作代码顺序列表，英文逗号（,）分隔。建议单动作，目前支持的动作有： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 嘴部动作建议嘴唇距离大于3厘米，左右摇头动作建议角度15-30度。 nod_threshold 否 Double 该参数为点头动作幅度的判断门限，取值范围：[1,90]，默认为10，单位为度。该值设置越大，则越难判断为点头。 detail 否 Boolean 响应参数similarity是否详细显示,默认为false。 true表示响应中的similarity为0~1000的小数。 false表示响应中的similarity为0~100的整数。

响应示例 状态码： 200 OK { "meta" : { "uuid" : "user_defined" }, "result" : { "service_name" : "ivs-standard", "count" : 1, "resp_data" : [ { "verification_result" : "valid", "verification_message" : "Successful certification", "verification_code" : 1000, "similarity" : "65", "idcard_result" : { "name" : "张三", "sex" : "男", "birth" : "2000-03-06", "ethnicity" : "汉", "address" : "XX省XX市XX区XX街道XX号", "number" : "44***********07", "issue" : "XX省XX市XX区XX派出所", "valid_from" : "2004-08-26", "valid_to" : "2034-08-26" }, "video_result" : { "alive" : true, "actions" : [ { "confidence" : 0.823, "action" : 1 }, { "confidence" : 0.823, "action" : 3 }, { "confidence" : 0.823, "action" : 2 } ], "picture" : "/9j/4AAQSkZJRgABAQEAYABgAAD/2w..." } } ] } } 状态码： 400 失败响应样例 { "error_code" : "IVS.0003", "error_msg" : "Some necessary request parameters in req_data is null." }

请求示例 使用身份证正、反面图片、人脸视频进行活体人证核验 POST https://{endpoint}/v2.0/ivs-standard { "meta" : { "uuid" : "user_defined" }, "data" : { "req_data" : [ { "idcard_image1" : "/9j/4AAQSkZJRgABAgEASA...", "idcard_image2" : "/9j/4AAAAABQSkZJRgABAg...", "video" : "/9j/4AAQSkZJRgABAgEASABIAAD...", "actions" : "1,3,2", "nod_threshold" : 10 } ] } }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 meta Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 result result object 调用返回结果。 表7 Meta 参数 参数类型 描述 uuid String 唯一标识此次请求的ID，用户自定义，不超过64位。 表8 result 参数 参数类型 描述 service_name String 子服务名称。 count Integer 执行检测的数量，与resp_data字段对应。 resp_data Array of RespDataByVideoAndIdCardImage objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表9 RespDataByVideoAndIdCardImage 参数 参数类型 描述 verification_result String 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 verification_message String 审核校验信息，具体参考校验信息说明 verification_code Integer 审核校验代码，具体参考校验信息说明 similarity String 人像相识度。取值范围[0,100]，当入参detail为true时，取值范围为[0,1000]。 idcard_result IdcardResult object 身份证图像的 文字识别 结果，具体参见IdcardResult。 video_result VideoResult object 动作活体检测的检测结果。 表10 IdcardResult 参数 参数类型 描述 name String 身份证上识别的名称。 number String 身份证号。 sex String 性别。 birth String 出生日期。 ethnicity String 民族。 address String 地址。 issue String 发证机关。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 表11 VideoResult 参数 参数类型 描述 alive Boolean 是否是活体。 actions Array of ActionsList objects 动作列表。 picture String 检测出最大人脸的图片base64。 表12 ActionsList 参数 参数类型 描述 confidence Double 置信度，取值范围0～1。 action Integer 动作编号，取值范围：[1,2,3,4]，其中： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 状态码： 400 表13 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String X-Auth-Token值获取方法请参见认证鉴权。 Enterprise-Project-Id 否 String 企业项目ID。IVS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用IVS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用IVS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用IVS服务，账单的企业项目会被分类到"default"中。 表2 请求Body参数 参数 是否必选 参数类型 描述 meta 是 Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 data 是 data object 请求消息的数据部分。 表3 Meta 参数 是否必选 参数类型 描述 uuid 否 String 唯一标识此次请求的ID，用户自定义，不超过64位。 表4 data 参数 是否必选 参数类型 描述 req_data 否 Array of ReqDataByVideoAndIdCardImage objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表5 ReqDataByVideoAndIdCardImage 参数 是否必选 参数类型 描述 idcard_image1 是 String 身份证人像面图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。 idcard_image2 否 String 身份证国徽面图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。 video 是 String 现场拍摄人像视频数据，使用base64编码。 视频文件大小不超过8MB，建议客户端压缩到200KB~2MB。要求base64编码后大小不超过10M。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式：h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 actions 是 String 动作代码顺序列表，英文逗号（,）分隔。建议单动作，目前支持的动作有： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 嘴部动作建议嘴唇距离大于3厘米，左右摇头动作建议角度15-30度。 nod_threshold 否 Double 该参数为点头动作幅度的判断门限，取值范围：[1,90]，默认为10，单位为度。该值设置越大，则越难判断为点头。 detail 否 Boolean 响应参数similarity是否详细显示,默认为false。 true表示响应中的similarity为0~1000的小数。 false表示响应中的similarity为0~100的整数。

请求示例 使用身份证姓名、号码进行身份核验 POST https://{endpoint}/v2.0/ivs-idcard-extention { "meta" : { "uuid" : "user_defined" }, "data" : { "req_data" : [ { "verification_name" : "张三", "verification_id" : "44***********07" } ] } }

响应示例 状态码： 200 OK { "meta" : { "uuid" : "user_defined" }, "result" : { "service_name" : "ivs-idcard-extention", "count" : 1, "resp_data" : [ { "verification_result" : "valid", "verification_message" : "Successful certification", "verification_code" : 1000 } ] } } 状态码： 400 失败响应样例 { "error_code" : "IVS.0003", "error_msg" : "Some necessary request parameters in req_data is null." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String X-Auth-Token值获取方法请参见认证鉴权。 Enterprise-Project-Id 否 String 企业项目ID。IVS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用IVS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用IVS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用IVS服务，账单的企业项目会被分类到"default"中。 表2 请求Body参数 参数 是否必选 参数类型 描述 meta 是 Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 data 是 data object 请求消息的数据部分。 表3 Meta 参数 是否必选 参数类型 描述 uuid 否 String 唯一标识此次请求的ID，用户自定义，不超过64位。 表4 data 参数 是否必选 参数类型 描述 req_data 否 Array of ExtentionReqDataByNameAndId objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表5 ExtentionReqDataByNameAndId 参数 是否必选 参数类型 描述 verification_name 是 String 被验证人的姓名。 verification_id 是 String 被验证人的身份证号码。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 meta Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 result result object 调用返回结果。 表7 Meta 参数 参数类型 描述 uuid String 唯一标识此次请求的ID，用户自定义，不超过64位。 表8 result 参数 参数类型 描述 service_name String 子服务名称。 count Integer 执行检测的数量，与resp_data字段对应。 resp_data Array of ExtentionRespDataByNameAndId objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表9 ExtentionRespDataByNameAndId 参数 参数类型 描述 verification_result String 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 verification_message String 审核校验信息，具体参考校验信息说明 verification_code Integer 审核校验代码，具体参考校验信息说明 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 meta Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 result result object 调用返回结果。 表7 Meta 参数 参数类型 描述 uuid String 唯一标识此次请求的ID，用户自定义，不超过64位。 表8 result 参数 参数类型 描述 service_name String 子服务名称。 count Integer 执行检测的数量，与resp_data字段对应。 resp_data Array of StandardRespDataByNameAndId objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表9 StandardRespDataByNameAndId 参数 参数类型 描述 verification_result String 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 verification_message String 审核校验信息，具体参考校验信息说明 verification_code Integer 审核校验代码，具体参考校验信息说明 similarity String 人像相识度。取值范围[0,100]，当入参detail为true时，取值范围为[0,1000]。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求示例 使用身份证姓名、号码、人脸图片进行人证核验 POST https://{endpoint}/v2.0/ivs-standard { "meta" : { "uuid" : "user_defined" }, "data" : { "req_data" : [ { "verification_name" : "张三", "verification_id" : "44***********07", "face_image" : "/9j/4BBQSkZJRgABAgEASB..." } ] } }

响应示例 状态码： 200 OK { "meta" : { "uuid" : "user_defined" }, "result" : { "service_name" : "ivs-standard", "count" : 1, "resp_data" : [ { "verification_result" : "valid", "verification_message" : "Successful certification", "verification_code" : 1000, "similarity" : "65" } ] } } 状态码： 400 失败响应样例 { "error_code" : "IVS.0003", "error_msg" : "Some necessary request parameters in req_data is null." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String X-Auth-Token值获取方法请参见认证鉴权。 Enterprise-Project-Id 否 String 企业项目ID。IVS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用IVS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用IVS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用IVS服务，账单的企业项目会被分类到"default"中。 表2 请求Body参数 参数 是否必选 参数类型 描述 meta 是 Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 data 是 data object 请求消息的数据部分。 表3 Meta 参数 是否必选 参数类型 描述 uuid 否 String 唯一标识此次请求的ID，用户自定义，不超过64位。 表4 data 参数 是否必选 参数类型 描述 req_data 否 Array of StandardReqDataByNameAndId objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表5 StandardReqDataByNameAndId 参数 是否必选 参数类型 描述 verification_name 是 String 被验证人的姓名。 verification_id 是 String 被验证人的身份证号码。 face_image 是 String 现场人像图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。 detail 否 Boolean 响应参数similarity是否详细显示,默认为false。 true表示响应中的similarity为0~1000的小数。 false表示响应中的similarity为0~100的整数。 crop 否 Boolean 是否允许对入参face_image进行人脸检测及图片裁剪，默认为true，表示允许。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 meta Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 result result object 调用返回结果。 表7 Meta 参数 参数类型 描述 uuid String 唯一标识此次请求的ID，用户自定义，不超过64位。 表8 result 参数 参数类型 描述 service_name String 子服务名称。 count Integer 执行检测的数量，与resp_data字段对应。 resp_data Array of ExtentionRespDataByIdCardImage objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表9 ExtentionRespDataByIdCardImage 参数 参数类型 描述 verification_result String 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 verification_message String 审核校验信息，具体参考校验信息说明 verification_code Integer 审核校验代码，具体参考校验信息说明 idcard_result IdcardResult object 身份证图像的文字识别结果，具体参见IdcardResult。 表10 IdcardResult 参数 参数类型 描述 name String 身份证上识别的名称。 number String 身份证号。 sex String 性别。 birth String 出生日期。 ethnicity String 民族。 address String 地址。 issue String 发证机关。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求示例 使用身份证正、反面图片进行身份核验 POST https://{endpoint}/v2.0/ivs-idcard-extention { "meta" : { "uuid" : "user_defined" }, "data" : { "req_data" : [ { "idcard_image1" : "/9j/4BBQSkZJRgABAgEASB...", "idcard_image2" : "/9j/4BBQSkZJRgABAgEASB..." } ] } }

响应示例 状态码： 200 OK { "meta" : { "uuid" : "user_defined" }, "result" : { "service_name" : "ivs-idcard-extention", "count" : 1, "resp_data" : [ { "verification_result" : "valid", "verification_message" : "Successful certification", "verification_code" : 1000, "idcard_result" : { "name" : "张三", "sex" : "男", "birth" : "2000-03-06", "ethnicity" : "汉", "address" : "XX省XX市XX区XX街道XX号", "number" : "44***********07", "issue" : "XX省XX市XX区XX派出所", "valid_from" : "2004-08-26", "valid_to" : "2034-08-26" } } ] } } 状态码： 400 失败响应样例 { "error_code" : "IVS.0003", "error_msg" : "Some necessary request parameters in req_data is null." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String X-Auth-Token值获取方法请参见认证鉴权。 Enterprise-Project-Id 否 String 企业项目ID。IVS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用IVS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用IVS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用IVS服务，账单的企业项目会被分类到"default"中。 表2 请求Body参数 参数 是否必选 参数类型 描述 meta 是 Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 data 是 data object 请求消息的数据部分。 表3 Meta 参数 是否必选 参数类型 描述 uuid 否 String 唯一标识此次请求的ID，用户自定义，不超过64位。 表4 data 参数 是否必选 参数类型 描述 req_data 否 Array of ExtentionReqDataByIdCardImage objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表5 ExtentionReqDataByIdCardImage 参数 是否必选 参数类型 描述 idcard_image1 是 String 身份证人像面图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。 idcard_image2 否 String 身份证国徽面图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。

响应示例 状态码： 200 OK { "meta" : { "uuid" : "user_defined" }, "result" : { "service_name" : "ivs-standard", "count" : 1, "resp_data" : [ { "verification_result" : "valid", "verification_message" : "Successful certification", "verification_code" : 1000, "similarity" : "65", "idcard_result" : { "name" : "张三", "sex" : "男", "birth" : "2000-03-06", "ethnicity" : "汉", "address" : "XX省XX市XX区XX街道XX号", "number" : "44***********07", "issue" : "XX省XX市XX区XX派出所", "valid_from" : "2004-08-26", "valid_to" : "2034-08-26" } } ] } } 状态码： 400 失败响应样例 { "error_code" : "IVS.0003", "error_msg" : "Some necessary request parameters in req_data is null." }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 meta Meta object 请求元数据，例如表征本次请求的唯一标注uuid。 result result object 调用返回结果。 表7 Meta 参数 参数类型 描述 uuid String 唯一标识此次请求的ID，用户自定义，不超过64位。 表8 result 参数 参数类型 描述 service_name String 子服务名称。 count Integer 执行检测的数量，与resp_data字段对应。 resp_data Array of RespDataByIdCardImage objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表9 RespDataByIdCardImage 参数 参数类型 描述 verification_result String 审核校验结果： "valid"表示身份审核通过； "invalid"表示身份审核不通过； "nonexistent"表示数据源没有该身份证号码，这种情况一般是被验证人正在办理户籍迁移，或者被验证人是军人或政要。 verification_message String 审核校验信息，具体参考校验信息说明 verification_code Integer 审核校验代码，具体参考校验信息说明 similarity String 人像相识度。取值范围[0,100]，当入参detail为true时，取值范围为[0,1000]。 idcard_result IdcardResult object 身份证图像的文字识别结果，具体参见IdcardResult。 表10 IdcardResult 参数 参数类型 描述 name String 身份证上识别的名称。 number String 身份证号。 sex String 性别。 birth String 出生日期。 ethnicity String 民族。 address String 地址。 issue String 发证机关。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求示例 使用身份证正、反面图片、人脸图片进行人证核验 POST https://{endpoint}/v2.0/ivs-standard { "meta" : { "uuid" : "user_defined" }, "data" : { "req_data" : [ { "idcard_image1" : "/9j/4AAQSkZJRgABAgEASA...", "idcard_image2" : "/9j/4AAAAABQSkZJRgABAg...", "face_image" : "/9j/4BBQSkZJRgABAgEASB..." } ] } }