华为云用户手册

API参数获取说明 表1 API参数说明 位置 参数 是否必选 参数类型 说明 查询master地址 region_name 是 String region英文名称，获取方式：表3的region字段。 保存监控项 monitor_item_id 是 Long 监控项id，获取方式：表5的monitor_item_id字段。 获取应用树 region_id 否 String 区域id，获取方式：表3的region字段。 获取应用树 business_id 是 Long 应用id，获取方式：表3的id字段。 获取应用树 env_tag_id 否 Long 环境标签id，获取方式：表4的id字段。 查询环境标签 business_id 是 Long 应用id，获取方式：表3的id字段。 获取组件列表 business_id 是 Long 应用id，获取方式：表3的id字段。 获取组件下的环境列表 app_id 是 Long 组件id，获取方式：表4的id字段。 查询单个应用的详情 business_id 是 Long 应用id，获取方式：表3的id字段。 查询子应用详情 sub_business_id 是 Long 子应用id，获取方式：表5的node_type字段为SUB_BUSINESS的对象，取real_id。 查询监控项配置信息 env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 查询监控项配置信息 collector_id 是 Long 采集器id，获取方式：表5的collector_id字段。 调用链拓扑图 trace_id 是 String 调用链traceId，获取方式：表5的trace_id字段。 获取event的详情 trace_id 是 String trace id，获取方式：表4的trace_id字段。 获取event的详情 span_id 是 String span id，获取方式：表4的span_id字段。 获取event的详情 event_id 是 String event id，获取方式：表4的event_id字段。 获取event的详情 env_id 是 Long 环境id，获取方式：表4的env_id字段。 获取span数据 env_id 否 Long 环境id，获取方式：表4的id字段。 获取span数据 instance_id 否 Long 实例id，获取方式：表4的instance_id字段。 获取span数据 app_id 否 Long 组件id，获取方式：表4的id字段。 获取span数据 biz_id 是 Long 应用id，获取方式：表3的id字段。 获取一个trace的所有调用链数据 trace_id 是 String 调用链ID，获取方式：表5的trace_id字段。 获取趋势图 view_config 是 TrendView object 视图配置信息，获取方式 ：表5的ViewBase对象。 获取趋势图 instance_id 否 Long 实例id，不填写时获取全部实例聚合数据，获取方式：表4的instance_id字段。 获取趋势图 monitor_item_id 是 Long 监控项id，获取方式：表5的monitor_item_id字段。 获取趋势图 env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 获取汇总表格数据 view_config 是 SumTableView object 视图配置信息，获取方式 ：表5的ViewBase对象。 获取汇总表格数据 instance_id 否 Long 实例id，不填写时获取全部实例聚合数据，获取方式：表4的instance_id字段。 获取汇总表格数据 monitor_item_id 是 Long 监控项id，获取方式：表5的monitor_item_id字段。 获取汇总表格数据 env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 获取原始数据表格 view_config 是 RawTableView object 原始数据表格视图，获取方式 ：表5的ViewBase对象。 获取原始数据表格 instance_id 是 Long 实例id，不填写时获取全部实例聚合数据，获取方式：表4的instance_id字段。 获取原始数据表格 monitor_item_id 是 Long 监控项id，获取方式：表5的monitor_item_id字段。 获取原始数据表格 env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 获取实例信息列表 env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 获取监控项信息 env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 查询告警列表 region 否 String region英文名称，获取方式：表3的region字段。 查询告警列表 business_id 是 Long 应用id，获取方式：表3的id字段。 查询告警列表 monitor_item_id 否 Long 监控项id，获取方式：表5的monitor_item_id字段。 查询告警列表 collector_id 否 Integer 采集器id，获取方式：表5的collector_id字段。 查询告警消息列表 alarm_data_id 是 Integer 告警事件id，获取方式：表4的id字段。 查询告警消息列表 region 是 String region英文名称，获取方式：表3的region字段。 查询应用全部拓扑图 target_business_id 是 Long 目标应用id，获取方式：表3的id字段。 查询应用全部拓扑图 env_tag_list 否 Array of integers 环境标签列表，可为空，获取方式：表4的id字段。 查询组件环境拓扑图 target_env_id 是 Long 环境id，获取方式：表5的node_type字段为ENVIRONMENT的对象，取real_id。 查询URL跟踪配置列表 business_id 是 Long 应用id，获取方式：表3的id字段。 查询URL跟踪配置列表 env_id 否 Long 环境id，获取方式：表4的id字段。 查询URL跟踪Region环境列表 business_id 是 Long 应用id，获取方式：表3的id字段。 查询URL跟踪Region环境列表 region 是 String region英文名称，获取方式：表3的region字段。 查询URL跟踪视图列表 business_id 是 Long 应用id，获取方式：表3的id字段。 查询URL跟踪视图列表 region 是 String region英文名称，获取方式：表3的region字段。 查询URL跟踪视图列表 env_id 否 Long 环境id，获取方式：表4的env_id字段。 查询URL跟踪视图详情 tx_name 是 String 事务名称，获取方式：表4的tx_name字段。 父主题： 附录

响应示例 状态码： 200 OK，请求响应成功。 { "region_list" : [ { "region_id" : "xx-xxxx-xxx", "region_name" : "xxx", "region" : "xx-xxxx-xxx" }, { "region_id" : "mock-region", "region_name" : "xxxx", "region" : "mock-region" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_timestamp 是 String 开始时间。 end_timestamp 是 String 结束时间。 url 否 String 需要查询的URL条件。 custom_key 否 String 需要查询的事件名。 str_val 否 String 需要查询的事件值。 page 否 Integer 页码。 page_size 否 Integer 每页包含数据。 order_by 否 String 排序规则（传参示例： 1 desc）。

响应示例 状态码： 200 OK，请求响应成功。 { "total_count" : 1, "row_list" : [ [ "str_val", "url", "invoke_count", "max_num_val", "min_num_val", "avg_num_val", "uv", "invoke_count_per_person" ], [ "abc", "http%3A%2F%2Flocalhost%3A8087%2Findex.html", 430, 0, 0, 0, 1, 430 ] ] } 状态码： 400 Bad Request，语义或参数有误。 { "error_code" : "apm2.00000001", "error_msg" : "internal error", }

请求示例 根据事件名、事件值和URL查询前端监控自定义详情表。 /v2/rum/view/custom-events-table/events-value-table-detail/{app_id} { "page" : 1, "page_size" : 10, "start_timestamp" : "-20m", "end_timestamp" : "now", "custom_key" : "User Information", "str_val" : "abc", "url" : "http%3A%2F%2Flocalhost%3A8087%2Findex.html" }

响应示例 状态码： 200 OK，请求响应成功。 { "total_count" : 1, "row_list" : [ [ "str_val", "url", "invoke_count", "max_num_val", "min_num_val", "avg_num_val", "uv", "invoke_count_per_person" ], [ "abc", "http%3A%2F%2Flocalhost%3A8087%2Findex.html", 430, 0, 0, 0, 1, 430 ] ] } 状态码： 400 Bad Request，语义或参数有误。 { "error_code" : "apm2.00000001", "error_msg" : "internal error", }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_timestamp 是 String 开始时间。 end_timestamp 是 String 结束时间。 url 否 String 需要查询的URL条件。 custom_key 否 String 需要查询的事件名。 str_val 否 String 需要查询的事件值。 page 否 Integer 页码。 page_size 否 Integer 每页包含数据。 order_by 否 String 排序规则（传参示例： 1 desc）。

请求示例 根据事件名查询前端监控自定义详情表。 /v2/rum/view/custom-events-table/events-key-table-detail/{app_id} { "page" : 1, "page_size" : 10, "start_timestamp" : "-20m", "end_timestamp" : "now", "custom_key" : "User Information" }

响应示例 状态码： 200 OK，请求响应成功。 { "category_info_list" : [ { "category_id" : 7, "category_name" : "Url", "display_name" : "接口调用", "sequence" : 1 }, { "category_id" : 5, "category_name" : "Base", "display_name" : "基础监控", "sequence" : 20 }, { "category_id" : 4, "category_name" : "Exception", "display_name" : "异常", "sequence" : 30 }, { "category_id" : 11, "category_name" : "Web", "display_name" : "Web容器", "sequence" : 80 }, { "category_id" : 10, "category_name" : "ProbeInfo", "display_name" : "探针监控", "sequence" : 90 } ], "monitor_item_info_list" : [ { "monitor_item_id" : 37, "disabled" : false, "collector_id" : 50, "sequence" : 1, "collect_interval" : 60, "category_id" : 7, "collector_name" : "Url", "display_name" : "URL监控", "show_in_total" : true }, { "monitor_item_id" : 16, "disabled" : false, "collector_id" : 36, "sequence" : 5, "collect_interval" : 60, "category_id" : 5, "collector_name" : "JVMInfo", "display_name" : "JVM信息", "show_in_total" : true }, { "monitor_item_id" : 14, "disabled" : false, "collector_id" : 28, "sequence" : 10, "collect_interval" : 60, "category_id" : 5, "collector_name" : "JVM", "display_name" : "JVM监控", "show_in_total" : true }, { "monitor_item_id" : 18, "disabled" : false, "collector_id" : 38, "sequence" : 10, "collect_interval" : 60, "category_id" : 5, "collector_name" : "GC", "display_name" : "GC监控", "show_in_total" : true }, { "monitor_item_id" : 20, "disabled" : false, "collector_id" : 48, "sequence" : 10, "collect_interval" : 60, "category_id" : 5, "collector_name" : "Thread", "display_name" : "线程", "show_in_total" : true }, { "monitor_item_id" : 13, "disabled" : false, "collector_id" : 20, "sequence" : 15, "collect_interval" : 60, "category_id" : 5, "collector_name" : "JavaMethod", "display_name" : "JAVA方法", "show_in_total" : true }, { "monitor_item_id" : 12, "disabled" : false, "collector_id" : 18, "sequence" : 20, "collect_interval" : 60, "category_id" : 4, "collector_name" : "Exception", "display_name" : "异常日志", "show_in_total" : true }, { "monitor_item_id" : 41, "disabled" : false, "collector_id" : 24, "sequence" : 55, "collect_interval" : 60, "category_id" : 11, "collector_name" : "Tomcat", "display_name" : "Tomcat监控", "show_in_total" : true }, { "monitor_item_id" : 11, "disabled" : false, "collector_id" : 16, "sequence" : 60, "collect_interval" : 60, "category_id" : 10, "collector_name" : "ProbeInfo", "display_name" : "探针监控", "show_in_total" : true } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 category_info_list Array of CollectorCategoryInfo objects 采集器类别集合。 monitor_item_info_list Array of MonitorItemEntity objects 监控项集合。 表4 CollectorCategoryInfo 参数 参数类型 描述 category_id Integer 采集器类别id。 category_name String 采集器类别名称。 display_name String 采集器类别展示名称。 sequence Integer 序列号。 表5 MonitorItemEntity 参数 参数类型 描述 category_id Integer 采集器类别id。 collector_name String 采集器名称。 display_name String 采集器类别展示名称。 show_in_total Boolean 是否展示标题。 monitor_item_id Long 监控项id。 disabled Boolean 是否禁用。 collector_id Integer 采集器id。 sequence Integer 序列号。 collect_interval Integer 默认数据采集间隔。

终端节点 终端节点（Endpoint）即调用API的请求地址， APM 2.0不同服务不同区域使用的终端节点相同，即：华北-北京四。 表1 APM 的Endpoint 区 域名 称 区域 终端节点（Endpoint） 协议类型 华北-北京四 cn-north-4 apm2.cn-north-4.myhuaweicloud.com HTTPS 表2 APM 的Endpoint 区域名称 区域 终端节点（Endpoint） 协议类型 亚太-新加坡 ap-southeast-3 iam.ap-southeast-3.myhuaweicloud.com HTTPS 父主题： 使用前必读

响应示例 状态码： 200 OK，请求响应成功。 { "default" : false, "id" : 1, "gmt_create" : null, "gmt_modify" : null, "name" : "LubanApm", "display_name" : "LubanApm", "is_default" : false, "inner_domain_id" : 3, "eps_id" : "", "creator_id" : null, "descp" : "", "create_time" : "2021-07-14 21:40:32", "modify_time" : "2021-07-14 21:40:47", "creator_name" : "test", "uuid" : "2fa7aca518fb4bc9b0e76a1488895324" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id Long 应用id。 gmt_create String 创建时间。 gmt_modify String 修改时间。 default Boolean 默认应用。 display_name String 应用的英文名称。 name String 应用的展示名称。 is_default Boolean 是否是默认的应用。 inner_domain_id Integer 内部租户id。 eps_id String 企业项目的id。 creator_id Long 创建者的userId。 descp String 应用描述说明。 create_time String 创建时间。 modify_time String 修改时间。 creator_name String 创建者的用户名。 uuid String 应用的唯一ID标识

响应示例 状态码： 200 OK，请求响应成功。 { "total_count" : 2, "row_list" : [ [ "custom_key", "url", "invoke_count", "uv", "last_report_ts" ], [ "User Information", "", 372, 1, 1733217187434 ], [ "Custom Load Time", "", 186, 1, 1733217187433 ] ] } 状态码： 400 Bad Request，语义或参数有误。 { "error_code" : "apm2.00000001", "error_msg" : "internal error", }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_timestamp 是 String 开始时间。 end_timestamp 是 String 结束时间. url 否 String 需要查询的URL条件。 custom_key 否 String 需要查询的事件名。 str_val 否 String 需要查询的事件值。 page 否 Integer 页码。 page_size 否 Integer 每页包含数据。 order_by 否 String 排序规则（传参示例： 1 desc）。

响应示例 状态码： 200 OK，请求响应成功。 { "total_count" : 1, "row_list" : [ [ "str_val", "url", "invoke_count", "uv", "last_report_ts" ], [ "abc", "http%3A%2F%2Flocalhost%3A8087%2Findex.html", 312, 1, 1733217650644 ] ] } 状态码： 400 Bad Request，语义或参数有误。 { "error_code" : "apm2.00000001", "error_msg" : "internal error", }

请求示例 根据事件名查询自定义事件值表格 /v2/rum/view/custom-events-table/events-value-table/{app_id} { "page" : 1, "page_size" : 10, "custom_key" : "User Information", "start_timestamp" : "-20m", "end_timestamp" : "now" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_timestamp 是 String 开始时间。 end_timestamp 是 String 结束时间。 url 否 String 需要查询的URL条件。 custom_key 否 String 需要查询的事件名。 str_val 否 String 需要查询的事件值。 page 否 Integer 页码。 page_size 否 Integer 每页包含数据。 order_by 否 String 排序规则（传参示例： 1 desc）。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 GET https://endpoint/v3/auth/projeAPM X-Auth-Token: ABCDEFG....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应示例 状态码： 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." }

请求示例 使用身份证姓名、号码、人脸图片进行人证核验 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 表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 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表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。 true表示允许服务对入参“face_image”进行人脸数量检测及图片裁剪。 false表示不允许服务对入参“face_image”进行人脸数量检测及图片裁剪。 说明： 如果图片在base64编码后，大小超过90K，因为该参数默认为true，对图片进行裁剪。有一定的概率，会产生IVS.0009报错，显示检测到的人脸数量为0。此时可以将参数值设置为false。

请求示例 使用身份证正、反面图片、人脸图片进行人证核验 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..." } ] } }

响应参数 状态码： 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 调用失败时的错误信息。 调用成功时无此字段。

响应示例 状态码： 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." }

请求参数 表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 ReqDataByIdCardImage objects 请求列表，用于支持批量调用。目前暂时只支持单个数据查询。 表5 ReqDataByIdCardImage 参数 是否必选 参数类型 描述 idcard_image1 是 String 身份证人像面图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。 idcard_image2 否 String 身份证国徽面图像数据，使用base64编码，要求base64编码后大小不超过4M。图像各边的像素大小在300到4000之间，支持JPG格式。 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。 true表示允许服务对入参“face_image”进行人脸数量检测及图片裁剪。 false表示不允许服务对入参“face_image”进行人脸数量检测及图片裁剪。 说明： 如果图片在base64编码后，大小超过90K，因为该参数默认为true，对图片进行裁剪。有一定的概率，会产生IVS.0009报错，显示检测到的人脸数量为0。此时可以将参数值设置为false。

使用前必读 用户需要具备编程能力，熟悉Java、Python、iOS、Android、Node.js编程语言。 OCR服务需要用户通过调用API接口，将图片或扫描件中的文字识别成可编辑的文本，然后返回JSON格式的识别结果，用户需要通过编码将识别结果对接到业务系统或保存为TXT、Excel等格式。 关于文字识别的相关声明请参见文字识别服务声明、隐私政策声明。 文字识别服务等级协议请参见华为云服务等级协议。

首次使用OCR 如果您是首次使用OCR的用户，建议您学习并了解如下信息： 功能介绍 通过功能介绍章节的内容，了解OCR不同类别的文字识别功能，包括通用类文字识别、证件类文字识别、票据类文字识别。 入门使用 OCR以开放API的方式提供给用户，您可以参考《快速入门》学习并使用OCR服务。 使用方式 如果您是一个开发工程师，熟悉代码编写，想要直接调用OCR服务，您可以参考《API参考》或《SDK参考》获取详情。 由浅入深学习 您可以参考成长地图，由浅入深学习使用OCR。