华为云用户手册

响应示例 状态码：200 请求成功。 { "api_version" : "v1", "kind" : "Component", "items" : [ { "id" : "610fb1de-5ac6-424e-b910-d7be902575d0", "name" : "demo-xxx", "annotations" : { "version" : "1.0.0", "enterprise_project_id" : "" }, "created_at" : "2022-06-09T07:01:05.323979Z", "updated_at" : "2022-06-09T07:01:05.323979Z", "spec" : { "runtime" : "Docker", "env_id" : "50d18173-5df0-4db4-a2b6-8a428d42146b", "replica" : 1, "source" : { "type" : "image", "url" : "xxx/demo-jar:v2" }, "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "" } }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "image_url" : "xxx/demo-jar:v2", "available_replica" : 1, "job_id" : "251b7d84-c353-416a-864f-5878a94c3d28", "status" : "running", "configuration_operation_id" : "xxx" } } ], "total_count" : 1 }

URI GET /v1/{project_id}/cae/applications/{application_id}/components 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 限制本次返回结果的条数。 offset 否 String 分页偏移位，查询起始位置。 status 否 String 组件状态。 created: 未部署。 running: 运行中。 paused: 已停止。 notReady: 未就绪。 sort_key 否 String 排序字段。 sort 否 String 升降序规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token ，请参考《 统一身份认证 服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本，固定值“v1”，该值不可修改。 kind 是 String API类型，固定值“Volume”，该值不可修改。 spec 是 VolumeSpec object volume规格信息。 表4 VolumeSpec 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型，当前只支持“obs”和“sfs”。 resource_sub_type 是 String 对象存储类型。 resources 是 Array of strings 云存储 名称。 resources_credentials 否 Array of ResourcesCredential objects 云存储和授权凭证，获取环境列表接口响应中env_category字段为v2时需添加该字段的值。 表5 ResourcesCredential 参数 是否必选 参数类型 描述 access 否 String 用户access key，当前access key应该包含访问授权云存储的权限。 secret 否 String 用户secret key，当前secret key应该包含访问授权云存储的权限。

请求示例 授权云存储，云存储类型为“obs”，存储桶名称为“test-bucket”。 POST https://{endpoint}/v1/{project_id}/cae/volumes { "api_version" : "v1", "kind" : "Volume", "spec" : { "resource_type" : "obs", "resource_sub_type" : "object_bucket", "resources" : [ "test-bucket" ], "resources_credentials" : [ { "access" : "xxx", "secret" : "xxx", "resources" : [ "test-bucket" ] } ] } }

URI DELETE /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Enterprise-Project-ID 否 String 企业项目ID。 创建环境时，环境会绑定企业项目ID。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

URI PUT /v1/{project_id}/cae/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求示例 更新组件代码源为源码仓库，组件名称“demo”，版本“1.0.0”，选择GitLab源码仓库，运行时为Java8。 PUT https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id} { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "demo", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "xxx", "dockerfile_path" : "xxx" } }, "source" : { "type" : "code", "sub_type" : "GitLab", "url" : "https://xxx:8090/xxx/cae-frontend.git", "code" : { "branch" : "master", "auth_name" : "gitlab-xxx", "namespace" : "em1n" } }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } } 更新组件代码源为镜像，组件名称“demo”，版本“1.0.0”，选择名称为“cae-demo”的镜像，运行时为Docker。 PUT https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id} { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "demo", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Docker", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "xxx" } }, "source" : { "type" : "image", "url" : "xxx/cae-demo:v1" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } } 更新组件代码源为软件包，组件名称“demo”，版本“1.0.0”，在OBS对象存储中选择名称为“forecast-1.0.0.jar”的软件包，运行时为Java8。 PUT https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id} { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "demo", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "openjdk:8u181-jdk-alpine", "dockerfile_content" : "xxx" } }, "source" : { "type" : "softwarePackage", "sub_type" : "BinObs", "url" : "https://xxx.obs.region.xxx.huawei.com/xxx/forecast-1.0.0.jar" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } }

服务治理概述 服务治理是一个非常宽泛的概念，一般指独立于业务逻辑之外，给系统提供一些可靠运行的系统保障措施。针对微服务场景下的常用故障模式，提供的保障措施包括： 负载均衡管理：提供多实例情况下的负载均衡策略管理，比如采用轮询的方式保障流量在不同实例均衡。当一个实例发生故障的时候，能够暂时隔离这个实例，防止访问这个实例造成请求超时等。 限流：流控的主要目的是提供负载保护，防止外部流量超过系统处理能力，导致系统崩溃。流控还被用于平滑请求，让请求以均匀分布的方式到达服务，防止突发的流量对系统造成冲击。 重试：重试的主要目的是保障随机失败对业务造成影响。随机失败在微服务系统经常发生，产生随机失败的原因非常多。以Java微服务应用为例，造成请求超时这种随机失败的原因包括：网络波动和软硬件升级，可能造成随机的几秒中断；JVM垃圾回收、线程调度导致的时延增加；流量并不是均匀的，同时到来的1000个请求和1秒内到来的1000个请求平均分布对系统的冲击是不同的，前者更容易导致超时；应用程序、系统、网络的综合影响，一个应用程序突然的大流量可能会对带宽产生影响，从而影响到其他应用程序运行；其他应用程序相关的场景，比如SSL需要获取操作系统熵，如果熵值过低，会有几秒钟的延迟。 系统不可避免地面临随机故障，必须具备一定的随机故障保护能力。 隔离仓：隔离仓通常针对系统资源占用比较多的业务进行保护。比如一个业务非常耗时，如果这个业务和其他业务共享线程池，当这个业务被大量突发访问时，其他业务都会等待，造成整个系统性能下降。隔离仓通过给资源占用比较多的业务分配独立的资源池（一般通过信号量或者线程池实现），避免对其他业务造成影响。 降级：降级治理是在业务高峰期时，需要临时减少对于目标服务的访问，达到降低目标服务负载；或者屏蔽对于非关键服务的访问，保持本服务的核心处理能力的治理措施。 服务治理的复杂性在于没有任何治理措施是适用于所有场景的。对于一个应用场景工作良好的治理手段，在另外一个场景可能成为问题。在业务运行周期，根据业务运行状态和指标，动态的更新治理策略非常重要。 在业务系统中使用服务治理，通常包括下面几个步骤： 开发业务。这个过程一般比较少关注服务治理的内容，以交付业务功能为重心。微服务开发框架针对常用的系统故障，一般都默认提供了保障措施，选择合适的微服务开发框架，可以节省DFx的时间。 性能测试和故障演练。这个过程中会发现非常多的系统不稳定问题，服务治理的策略会在解决这些问题的过程中应用，并写入配置文件作为应用程序缺省值。 业务上线运行。上线运行的过程中碰到未考虑的场景，需要采用配置中心动态调整治理参数，以保障业务平稳运行。 上面的3个步骤在整个软件生命周期会不断迭代完善。描述如何使用所有的治理能力是复杂的，微服务引擎针对不同的微服务开发框架，提供了一个统一的基于流量特征的服务治理能力。如果使用微服务框架开发应用，在应用托管后启动应用，微服务会自动注册到对应的微服务引擎，您可以到微服务引擎控制台进行服务治理的相关操作请参考治理微服务。 本章节重点介绍如何使用基于流量特征的服务治理能力。 父主题： 使用服务治理

前提条件 已基于Java Chassis开发好了微服务应用。 Java Chassis框架下的微服务应用开发，请参考https://servicecomb.apache.org/references/java-chassis/zh_CN/。 版本要求：请参见微服务开发框架版本要求。 本文假设您的项目使用了maven管理打包，您熟悉maven的依赖管理机制，能够正确的修改“pom.xml”文件中的dependency management和dependency。 Java Chassis支持和不同的技术进行组合使用，配置文件的名称和实际使用的技术有关。如果您采用Spring方式使用Java Chassis，配置文件的名称一般为“microservice.yaml”，如果您采用Spring Boot方式使用Java Chassis， 配置文件名称一般为“application.yaml”。本文统一使用“microservice.yaml”表示配置文件，请结合实际项目进行区分。

出租车发票识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到4096px之间。单个图片对应的Base64编码不超过10MB。 图像中发票区域有效占比超过25%，保证整张发票内容及其边缘包含在图像内。 支持少量扭曲，扭曲后图像中的发票长宽比与实际发票相差不超过10%。 支持图像中出租车发票任意角度的水平旋转。 文字识别 服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

泰文身份证识别 只支持泰国身份证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 泰国身份证识别图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中身份证区域有效占比超过25%，保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。 目前只支持识别单张身份证的正面或者反面。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前。

火车票识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中火车票区域有效占比超过25%。 支持图像中火车票任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的火车票长宽比与实际火车票相差不超过10%。 支持识别铁路电子客票（含OFD格式）。 铁路电子客票识别当前仅支持2024.11.01正式发行前的试行版式。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

保险单识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中保险单区域有效占比超过70%，保证整张保险单及其边缘包含在图像内。 支持图像中保险单旋转、支持少量扭曲。 能处理暗光等干扰的图片但影响识别精度。 覆盖常见保险公司的常见保单版式，由于即使是同一家保险公司，保险种类也繁多而且都在动态变化，实际支持情况请以实际测试效果为准。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

财务报表识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15px到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证整张表格及其边缘包含在图像内。 支持图像任意角度的水平旋转。 目前不支持复杂背景（如户外自然场景、防伪水印等）和表格线扭曲图像的文字识别。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

承兑汇票 只支持中英文。 只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD格式的图片。 图像各边的像素大小在15px到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。 不支持角度旋转的图片识别。 支持电子承兑汇票，对于拍照场景、复杂背景支持欠佳。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

银行回单识别 支持JPEG、JPG、PNG、BMP、TIFF、PDF格式，多页PDF默认识别第一页。 图像各边的像素大小在15px到8192px之间。单个图片、PDF文件其对应的Base64编码不超过10MB。 支持同时返回单张图像中存在的多张回单识别结果。 图像中key值对应的value值为空时，不会返回对应的键值对。 目前不支持复杂背景（如户外自然场景、防伪水印等）和文字扭曲图像的文字识别。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

手写文字识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。 支持图像任意角度的水平旋转（需开启方向检测）。 目前不支持复杂背景（如户外自然场景、防伪水印等）和表格线扭曲图像的文字识别。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

车辆合格证 只支持中国大陆车辆合格证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证整张车辆合格证内容及其边缘包含在图像内。 支持图像中车辆合格证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的车辆合格证长宽比与实际驾驶证相差不超过10%。 能处理暗光等干扰的图片但影响识别精度。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

机动车销售发票识别 支持识别PNG、JPG、JPEG、BMP、TIFF、PDF格式。 图像各边的像素大小在100到8000px之间。单个图片、PDF文件其对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证整张发票及其边缘包含在图像内。 支持图像中发票任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的发票长宽比与实际发票相差不超过10%。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

通用文字识别 只支持识别PNG、JPG、JPEG、BMP、GIF、TIFF、WEBP、PCX、ICO、PSD、PDF格式的图片。 图像各边的像素大小在15px到30000px之间。单个图片、PDF文件其对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证所有文字及其边缘包含在图像内。 支持图像任意角度的水平旋转。 支持自动过滤浅色文字水印。 目前不支持复杂背景（如户外自然场景等）和文字扭曲图像的文字识别。 支持中英文以及部分繁体字、马来语、乌克兰语、印地语、俄语、越南语、印尼语、泰语、阿拉伯语、德语、拉丁语、法语、意大利语、西班牙语、葡萄牙语、罗马尼亚语、波兰语、阿姆哈拉语、日语、韩语、土耳其语、挪威语、丹麦语、瑞典语、柬埔寨语、希伯来语识别。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

银行卡识别 只支持识别JPG、JPEG、PNG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 只支持识别银行卡正面，不支持识别背面。 只支持识别85.60×53.98 mm常规大小的银行卡，不支持迷你卡和形状不规则的异形卡。 支持图像中银行卡任意角度的水平旋转。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

道路运输从业资格证识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15px到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中识别区域有效占比超过80%，保证整张表格及其边缘包含在图像内。 支持图像任意角度的水平旋转。 目前不支持复杂背景（如户外自然场景、防伪水印等）和表格线扭曲图像的文字识别。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

名片识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中名片的有效占比超过60%，保证整张名片内容包含在图像内。 支持图像中名片的任意角度的水平旋转（需开启方向检测）。 能处理反光、暗光、防伪标识等干扰的图片但影响识别精度。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

哥伦比亚身份证 支持哥伦比亚身份证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在15px到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中身份证区域有效占比超过80%，保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。 目前只支持识别单张身份证的正面或者反面。

发票验真 支持增值税专用发票、增值税普通发票、增值税普通发票（卷式）、增值税电子专用发票、增值税电子普通发票、增值税电子普通发票（通行费）、二手车销售统一发票、机动车销售统一发票、 区块链 电子发票和全电发票，共计10种发票信息核验。 每份发票每天最多可查验5次。可查验最近5年内（国家税务总局）增值税发票管理系统开具的发票。 税务局数据同步有时延，建议当天新开的发票在24小时后查询。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

网络图片识别 支持中英文及部分中文繁体字。 只支持识别JPG、JPEG、PNG、BMP、TIFF、TGA、WEBP、ICO、PCX、GIF格式图片。 支持常见网络图片如：手机截图、电脑截图、电商产品图及广告设计图等互联网图片。 图像各边的像素大小在15到30000px之间。单个图片对应的Base64编码不超过10MB。 图像中有效文字图片占比超过60%，避免有效文字图片占比过小。 支持图像中有效文字图片的任意角度的水平旋转（需开启方向检测）。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

身份证识别 支持中华人民共和国居民身份证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中身份证区域有效占比超过25%，保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。 目前支持识别单张身份证的正面或者反面。 支持居民身份证的正反面同时识别，不支持存在两张及以上同面身份证的图片识别。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

行驶证识别 只支持中国大陆行驶证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在100到8192px之间。单个图片对应的Base64编码不超过10MB。 图像中行驶证区域有效占比超过5%，保证整张行驶证内容及其边缘包含在图像内。 支持图像中行驶证任意角度的水平旋转。 支持少量扭曲，扭曲后图像中的行驶证长宽比与实际行驶证相差不超过10%。 能处理反光、暗光、防伪标识等干扰的图片但影响识别精度。 目前只支持识别2008年版的行驶证。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。

营业执照识别 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片及PDF。 图像各边的像素在15到8192px之间。单个图片、PDF文件其对应的Base64编码不超过10MB。 图像中营业执照区域有效占比超过70%，保证整张营业执照及其边缘包含在图像内。 支持图像中营业执照旋转、支持少量扭曲。 能处理暗光等干扰的图片但影响识别精度。 文字识别服务属于公有云服务，线上用户资源共享，如果需要多并发请求，请提前联系我们。