开放能力
开发平台
行业应用
生态合作
开发与教学
资讯 社区 控制台
技术能力
语音技术
图像技术
文字识别
人脸与人体识别
视频技术
AR与VR
自然语言处理
知识图谱
数据智能
场景方案
部署方案
行业应用
智能教育
智能医疗
智能零售
智能工业
企业服务
智能政务
智能农业
信息服务
智能园区
智能硬件
文字识别

    标准模型部署

    一、资源规划

    资源规划文档旨在系统资源使用层对真实交付场景做产品层面的通用指导

    文档涵盖了构建百度OCR算子服务所需要的服务器主机、 CPU、内存、 GPU、网络等内容方面的规划。 本文档所列出的所有数量数字方面的值均需针对实际场景需求和限制做针对性调整。

    名词定义

    名称 含义
    鉴权服务 鉴权服务包含百度发布的服务授权证书,如果不安装鉴权服务,后续的应用服务也将无法启动,目前支持加密狗(硬件)和提取机器指纹(软件)两种鉴权方式
    应用服务 包含Docker等基础环境以及相关技术方向的算法模型,是私有化产品的的核心。部署应用服务的前提是部署鉴权服务,应用服务在运行时会实时请求鉴权服务,需要保障两个服务之间能够顺利通信
    单机一键部署 适用于鉴权服务、应用服务部署在一台物理机上的场景。即执行一条命令将鉴权服务、应用服务安装完成。
    多机分离部署 适用于鉴权服务、应用服务不在一台机器上部署的场景。首先部署鉴权服务、然后部署应用服务
    测试环境 客户方提供的进行产品、场景测试的环境,一般与生产环境隔离,开发、测试能够方便接触到的环境,对部署的可用性要求较低
    生产环境 客户的生产环境,一般的业务系统真实提供服务的环境,具备较高的可用性要求,包括异地多活的灾备要求。一般只有运维人员有该环境的超管权限

    物理架构拓扑图

    文字识别私有化部署产品包含鉴权服务和应用服务,其中

    • 鉴权服务通过客户网关系统连接到应用服务器为应用服务提供鉴权认证
    • 应用服务部分直接或通过生产级网关被客户业务场景直接使用

    iocr拓扑图.jpg

    鉴权应用

    规划原则:

    鉴权服务是运行百度文字识别应用服务的基础,如果鉴权异常,将直接导致模型的API接口不可用。鉴权服务健康节点数需满足大于等于N/2 + 1个 (N表示鉴权服务节点总数,并向下取整),如N=2,需保证2个节点鉴权服务都正常才能保证整体鉴权服务可用;如N=3,需保证存在2个节点鉴权服务正常才能保证整体鉴权服务可用,否则直接影响模型应用可用性。

    规划流程:

    一般建议鉴权节点数量为1或3个。

    模型算子应用

    规划原则:

    • 单模型应用实例承担流量,根据业务逻辑复杂度(请求报文)、机器节点硬件条件(CPU、内存、网络、显存)强相关
    • 单模型应用实例的内存分配依赖模型的大小
    • 单模型应用实例的CPU资源与请求报文相关
    • 单模型应用实例占用网路IO与请求报文和返回结果相关
    • 单模型应用实例占用磁盘空间大小与请求报文、日志输出量等特性相关
    • 场景需要的模型应用服务资源与整体业务QPS、单模型实例性能、高可用方案相关

    规划流程:

    根据实际场景进行性能测试,得出单模型实例性能指标(QPS、响应延时、内存占用、显存占用),结合场景高峰流量预估和高可用要求,以及服务器实际显卡数量等计算需要模型应用实例数,根据机器节点硬件资源指标,最终确定硬件节点数。

    资源规划示例

    模块清单

    模块名 模块角色说明
    openresty 基础依赖服务,提供负载均衡能力
    docker 基础依赖服务
    nvidia 基础依赖服务
    redis 基础依赖服务
    …… 基础依赖服务
    c-offline-security-server 鉴权服务
    auth-manage-service 鉴权服务,用于鉴权管理,提供web页面查看鉴权信息。
    ocr-x x x x x 模型应用服务
    …… 模型应用服务

    以上模块清单针对不同的模型部署包稍有差异,可以通过下面的命令查询当前部署包内详细的模块清单。

    # se :表示search,根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    cd origin/package/Install && python install.py se

    您可以根据模型的数量适当调整cpu,内存,显存,存储等资源,下面以在单台服务器部署1个模型为例说明:

    资源需求

    节点

    部署模块

    单节点CPU

    单节点内存

    单节点显卡数

    单节点存储

    单节点网络

    测试环境

    节点A

    基础依赖服务

    4核

    8G

    视模型情况而定

    50G

    >1000Mbps

    鉴权服务和鉴权管理服务

    模型应用服务

    生产环境

    节点A

    基础依赖服务

    8核

    16G

    视模型情况而定

    500G

    >1000Mbps

    模型应用服务

    节点B

    鉴权服务

    1核

    2G

    不需要

    10G

    >1000Mbps

    生产环境

    节点A

    鉴权服务

    8核

    16G

    视模型情况而定

    500G

    >1000Mbps

    基础依赖服务

    模型应用服务

    节点B

    基础依赖服务

    8核

    16G

    视模型情况而定

    500G

    >1000Mbps

    模型应用服务

    以上资源数值为推荐参考值,可根据实际情况做测试和调整。

    如果您有多个服务器节点,可以参考以上示例,选择每台服务器节点需要部署的服务。

    二、场景与名词

    场景说明

    • (无环境)全新部署:服务器环境为第一次部署,该服务器之前没有部署过百度文字识别产品的任何模型。
    • (有环境)升级模型:是指用户之前部署过老版本的百度文字识别产品模型,需要对模型进行升级操作。
    • (有环境)新增模型:是指用户当前服务器或者其他服务器已经部署过百度文字识别产品部分模型,需要新增其他模型
    • 回滚:回滚到最近一次升级前的版本
    • 卸载: 删除已经安装的模块

    名词解释

    名词 说明 示例
    package_dir 存放部署包、升级包的路径,包体积较大,尽量不要放在/下 如 /mnt/disk0/baidu_ocr_install_20111009
    work_dir 应用程序文件存储地址,默认为/home/baidu/work 如 /home/baidu/work

    三 、准备工作

    环境检查

    部署之前请务必参考此文档部署前环境检查必看进行硬件、网络、及软件环境检查,以避免在安装部署过程中出现问题。

    获取部署包

    1、申请正式模型部署包安装文件下载链接,下载模型部署包并重命名。

    # 示例如下,-O --output-document=FILE  对文件重命名,O为大写英文字母
    # 请将示例中的9C20XXXXXXXX.tar.gz替换为真实的文件名
    wget -O 9C20XXXXXXXX.tar.gz https://bj.bcebos.com/v1/private-ai-online/9C20XXXXXXX.tar.gz?authorization=bce-authXXXXXXX132187fcf81 

    2、将9C20XXXXXXXX.tar.gz上传到待部署的服务器,为方便区分不同的部署包,建议以【baidu_ocr_install + 日期】命名,如 baidu_ocr_install_20111009,该目录我们将其命名为package_dir

    3、进入package_dir 执行以下命令解压部署包

    # baidu_ocr_install_20111009 部署包的根目录,次处仅为示例,实际操作时换成您上一步命令的路径
    cd baidu_ocr_install_20111009 && tar zxvf 9C20XXXXXXXX.tar.gz

    4、解压后进入original目录执行bash download.sh命令获取全部安装文件,执行脚本后会自动下载以下安装文件:数据库服务安装包、鉴权服务安装包、应用服务安装包以及docker安装包等基础依赖环境。如果已经提前在办公网络下载完毕,请忽略该步骤。

    cd original && bash download.sh

    执行结束后,会在download.sh同级目录下生成download.log日志记录下载详情。

    若您在此过程出现问题,请提交工单联系百度的工作人员

    接下来您可以根据实际使用场景和前文的资源规划,从下文选择一种部署方式来部署。

    四、全新部署

    指服务器环境为第一次部署,该服务器之前没有部署过任何百度文字识别产品的任何模型。

    您可以进入模型部署包的存储位置,按照如下步骤操作查看该命令的help信息:

    cd original/package/Install
    python install.py

    返回结果如下:

    install.py usage:
    inall: 安装所有的产品以及鉴权服务和基础服务,适用于在单台物理机上安装所有模块的场景
    in, install: 安装一个模块,名称不区分大小写,适用于产品模块和鉴权服务分机器部署的场景
    se, search: 根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    li, list: 根据模块名称查询某个模块是否已经安装,如果没有指定名称则输出所有已经安装的模块
    rm, remove: 根据模块名称删除某个已经安装的模块;如果有其他模块依赖这个模块,则不允许删除
    rmall: 删除所有已经安装的模块
    lu, licenseupdate: 更新license文件,适用于授权延期、实例数扩容、增加产品授权
    up, upgrade: 升级指定模块,不区分大小写,不指定参数时输出所有可升级模块信息
    rb, rollback: 回滚指定模块,不区分大小写,回滚到最近一次升级前的版本
    du, safestoredataupdate: 安全存储数据更新,包括敏感数据、模型解密密钥等相关文件的更新

    请根据前文的资源规划和实际的使用场景从【单机一键部署】和【多机分离部署】选择一种方式部署。

    单机一键部署

    如果您只有一台服务器,可以使用inall参数来部署,inall 表示install all,安装所有的产品以及鉴权服务和基础服务,适用于在单台服务器上安装所有模块的场景,容易和 install 混淆,在使用时请注意。

    1、使用root权限启动一键部署脚本进行安装:

    # inall: 安装所有的产品以及鉴权服务和基础服务,适用于在单台物理机上安装所有模块的场景
    python install.py inall

    执行安装后,首先进行环境检查

    未通过的检查项详情如下:
     
    +---------------------------+-------------+--------------+----------+--------------------+
    |            模块           |    检查项   |     含义     | 指标要求 | 实际参数或报错信息 |
    +---------------------------+-------------+--------------+----------+--------------------+
    |          default          | * disk_home | HOME磁盘空间 | >=512 GB |       201 GB       |
    | c-offline-security-server |   machine   |  宿主机环境  |          |  当前环境为虚拟机  |
    +---------------------------+-------------+--------------+----------+--------------------+
    带*的检查项非强制,可以选择跳过
    2021-08-27 21:44:37,414 - 2712 - install - ERROR - 环境检查失败!请修复未通过的检查项后重新安装,如有问题请联系技术支持。
    按任意键结束。输入continue后回车可跳过环境检查,跳过后不保证安装成功。

    其中带 * 项 (如 disk_home等)非强制要求,可以忽略。确认无误后请输入 continue 英文字符,继续下一步

    之后会要求手动输入IP地址和选用的显卡编号,示例如下:

    请输入鉴权集群的IP列表,逗号分隔,列入:192.168.1.101
    # 参考上文资源规划,如鉴权节点唯一,只需要输入真实机器IP即可,如106.12.141.217
    # 如果鉴权节点有多个,请以英文逗号分隔,如106.12.141.217,106.12.141.218,106.12.141.219
    106.12.141.217
    # 输入您要使用的显卡编号,仅输入1个。可通过nvidia-smi查看显卡编号
    enter value for gpu index numbers used by this application,separated by comma, e.g. 0,1,2:

    2、确认本次安装模块是否完整:

    执行docker ps -a |grep baidu查看相关容器是否包含以下且状态均正常

    以【通用文字识别模型(CPU)版本】为例:

    [root@instance-wch0lkwp Install]# docker ps -a|grep baidu
    CONTAINER ID        IMAGE                                                                    COMMAND                  CREATED             STATUS                         PORTS                    NAMES
    c1643ee21c44        registry.baidu.com/aipe/openresty:1.11.2.3-trusty                        "/usr/local/openre..."   40 seconds ago      Restarting (1) 6 seconds ago                            nginx-1
    c766cdbbdb73        iregistry.baidu-int.com/aipe/public/centos:cuda10.0-cudnn7-c7-gcc8-ocr   "sh start.sh"            40 seconds ago      Up 3 seconds                   0.0.0.0:8138->8256/tcp   ocr-finance-gpu-1

    如果只有一个模型应用实例,则不需要部署负载均衡服务,可以执行以下命令移除nginx容器

    docker rm -f nginx-1
    如何单独部署某个模块?

    1.首入通过se参数检索当前部署包内包含的所有模块清单

    # se :表示search,根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    python install.py se 

    返回结果如下:

    ……
    模块名: openresty, 内置版本 7, 依赖模块 []
    模块名: docker, 版本号:1.0, 内置版本 5, 依赖模块 []
    ……

    2.如需卸载openresty,可以执行如下命令(此处仅为示例,实际操作中根据需要执行)

    # rm :remove, 根据模块名称删除某个已经安装的模块;如果有其他模块依赖这个模块,则不允许删除
    python install.py rm openresty

    3.重新安装openresty,则可以执行(此处仅为示例,实际操作中根据需要执行)

    # in :install, 安装某个模块,名称不区分大小写
    python install.py in openresty
    接下来请直接进入服务验证章节。

    多机分离部署

    如果您有多台服务器需要部署服务,可以参考第一章节的资源规划示例,尝试规划每台服务器需要部署的服务类型

    1、查询当前部署包内包含的模块清单

    # se :表示search,根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    python install.py se 

    2、选择您要安装的模块部署

    # in :install, 安装某个模块,名称不区分大小写
    python install.py in 模型名

    接下来请直接进入服务验证章节。

    五、升级模型

    升级模型部署,是指您之前部署过老版本的百度文字识别产品模型,需要对模型进行升级操作。

    方法一:

    1、首先查询新的部署包内包含的模块清单

    # se :表示search,根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    python install.py se 

    2、选择您要升级的模型模块并更新授权证书

    # up, upgrade: 升级指定模块,不区分大小写,不指定参数时输出所有可升级模块信息
    python install.py up 模块名(这里指模型)
    
    # lu, licenseupdate: 更新license文件,适用于授权延期、实例数扩容、增加产品授权
    python install.py lu

    方法二:

    进入旧模型部署包(可以参考上文约束的命令规范:baidu_ocr_install_日期找到历史部署包)卸载当前版本的模型,之后进入新申请的部署包选择要升级的模型安装。

    示例:

    ll
    ### 返回结果如下:
    # drwxr-xr-x 2 root root 4096 10月 26 16:56 baidu_ocr_install_20211025
    # drwxr-xr-x 2 root root 4096 10月 26 16:56 baidu_ocr_install_20211026
    
    # 进入旧部署包
    cd baidu_ocr_install_20211025/original/package/Install
    # 查看当前部署包内置的模块
    python install.py se
    # 卸载指定模型
    python install.py rm 模型模块名
    
    # 进入新申请的部署包
    cd baidu_ocr_install_20211026/original/package/Install
    # 查看当前部署包内置的模块,找到该模型的模块
    python install.py se
    # 安装同名模型
    python install.py in 该模型的模块名

    接下来请直接进入服务验证章节。

    六、新增模型

    1、查询新的部署包内包含的模块清单,依次部署所需要的依赖

    # 进入新申请的部署包
    cd original/package/Install
    
    # se :表示search,根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    python install.py se 
    
    # in :install, 安装某个模块,名称不区分大小写
    python install.py in docker

    如果有其他依赖需要安装的话(如您需要使用GPU等,需要额外安装nvidia模块),步骤同上。此处不再提供示例。

    2、部署指定模型模块并更新授权证书

    # in :install, 安装某个模块,名称不区分大小写
    python install.py in 模型名(模型模块)
    
    # lu, licenseupdate: 更新license文件,适用于授权延期、实例数扩容、增加产品授权
    python install.py lu

    最后请直接进入服务验证章节。

    七、回滚

    license回滚

    在新申请获取的部署包内执行license更新操作后,如果发现证书异常可以通过下面的方法回滚,

    找到旧部署包(可以参考上文约束的命令规范:baidu_ocr_install_日期),执行license update操作

    # 进入旧的部署安装包,执行如下命令替换当前的license文件
    # lu,表示 license update
    cd original/package/Install && python install.py lu

    应用回滚

    1、查询部署包内包含的模块清单

    # se :表示search,根据模块名称查询安装包里是否包括某个模块,不区分大小写,如果没有指定名称则输出安装包里所有模块信息
    python install.py se

    2、选择您要回滚的模块

    # rb, rollback: 回滚指定模块,不区分大小写,回滚到最近一次升级前的版本
    python install.py rb 模块名

    若您在此过程出现问题,请提交工单联系百度的工作人员

    八、 销毁

    支持一键卸载所有模块

    cd original/package/Install
    # rmall: 删除所有已经安装的模块
    python install.py rmall

    或者卸载指定模块

    # rm, remove: 根据模块名称删除某个已经安装的模块;如果有其他模块依赖这个模块,则不允许删除
    python install.py rm 模块名

    九、验证服务可用性

    docker验证

    Docker使用Linux桥接,在宿主机虚拟一个Docker容器网桥(docker0),Docker启动一个容器时会根据Docker网桥的网段分配给容器一个IP地址,称为Container-IP,同时Docker网桥是每个容器的默认网关。docker支持以下几种网络模式:

    Docker网络模式 配置 说明
    host模式 --net=host 容器和宿主机共享Network namespace。
    container模式 --net=container:
    NAME_or_ID
    容器和另外一个容器共享Network namespace。 kubernetes中的pod就是多个容器共享一个Network namespace。
    none模式 --net=none 容器有独立的Network namespace,但并没有对其进行任何网络设置,如分配veth pair 和网桥连接,配置IP等。
    bridge模式 --net=bridge (默认为该模式)

    可以通过以下命令来检查

    # 检查Docker0网桥是否存在
    ifconfig docker0
    
    # 检查docker网络模式
    docker network ls
    
    # 返回结果
    NETWORK ID          NAME                DRIVER              SCOPE
    67e23d654553        bridge              bridge              local
    f556c06b2f95        easypack            bridge              local
    7510479836a5        host                host                local
    56137f8c2dd4        none                null                local

    如果检测到没有docker0网桥或者网络模式没有bridge桥接模式,请参考修改容器网络模式

    应用服务验证

    下面以【通用文字识别模型(CPU版本)】举例说明:

    docker ps -a |grep baidu 

    查看容器运行状态,返回如下

    [root@instance-wch0lkwp Install]# docker ps -a |grep baidu 
    CONTAINER ID        IMAGE                                                                    COMMAND                  CREATED             STATUS                          PORTS                    NAMES
    8907bb94906d        iregistry.baidu-int.com/aipe/public/centos:cuda10.0-cudnn7-c7-gcc8-ocr   "sh start.sh"            21 hours ago        Up 21 hours                     0.0.0.0:8127->8256/tcp   ocr-general-cpu-1

    解释说明:

    hostPort:containerPort:映射本机的指定端口到容器内的指定端口

    如 0.0.0.0:8127->8256 表示:

    容器内应用监听端口号为8256, 映射到宿主机的端口号为8127

    判断算子应用服务是否启动:

    # 在宿主机验证接口返回结果
    curl 0.0.0.0:8127/status
    
    # 在宿主机验证容器内接口返回结果(可选)
    docker exec -it ocr-finance-gpu-1 bash -c 'curl 0.0.0.0:8256/status'

    正常返回示例如下

    non_service_error: 0
    connection_count: 1
    
    [baidu.aikl.ocr.GeneralClassifyService]
    
    process (GeneralSvrRequest) returns (GeneralSvrResponse)
    count: 0
    error: 0
    error_qps: 0
    latency: 0
    latency_50: 0
    latency_90: 0
    latency_99: 0
    latency_999: 0
    latency_9999: 0
    max_latency: 0
    qps: 0
    processing: 0
    
    
    classify (ClassifyRequest) returns (ClassifyResponse)
    count: 2
    error: 0
    error_qps: 0
    latency: 0
    latency_50: 0
    latency_90: 0
    latency_99: 0
    latency_999: 0
    latency_9999: 0
    max_latency: 0
    qps: 0
    processing: 0

    /status接口正常返回可以初步判断算子服务已经正常启动,接下来需要进一步验证完整功能(包括鉴权部分等)是否可用。

    请根据接口说明文档中的接口路径(process 或 classify)来选择对应的代码示例。

    GeneralClassifyService/process-单层base64加密示例代码:

    #!/usr/bin/python
    #-*- coding:UTF-8 -*-
    import SimpleHTTPServer
    import SocketServer
    import sys
    import urllib2,urllib
    import base64
    import hashlib
    import json
     
    url = "http://127.0.0.1:8127/GeneralClassifyService/process"  #此处ip需填写部署ocr的机器ip,端口填写ocr服务端口
    with open('./test.jpg', "rb") as f:   #此处需填写请求图片的地址
        img = f.read()  
    base64Data = base64.b64encode(img)
    input={        
        'logid':'test_9527', #无实际意义,可不传
        'format':'json',
        'object_type': 'general_v5',#识别对象类型,根据接口文档调整
        'type': 'st_ocrapi',
        'image': base64Data
    }
    postData = {
        'provider':'default', #默认值
        'input': json.dumps(input)
    }
    req_json = json.dumps(postData)
    req = urllib2.Request(url)
    req.add_header('Content-Type', 'application/json')
    response = urllib2.urlopen(req, req_json, 1000).read()
    res = json.loads(response)  #将结果的json数据格式转化为字典类型
    print res

    GeneralClassifyService/classify-双层base64加密示例代码:

    #!/usr/bin/python
    #-*- coding:UTF-8 -*-
    import SimpleHTTPServer
    import SocketServer
    import sys
    import urllib2,urllib
    import base64
    import hashlib
    import json
    
    url = "http://127.0.0.1:8017/GeneralClassifyService/classify"  #此处ip需填写部署ocr的机器ip,端口填写ocr服务端口
    with open('./test.jpg', "rb") as f:   #此处需填写请求图片的地址
        img = f.read()  
    base64Data = base64.b64encode(img)        
    request_str = 'type=st_ocrapi&detecttype=LocateRecognize&languagetype =CHN_ENG&imgDirection=setImgDirFlag&recg_type=seq&loc ate_type=v2&caps_original=true'   #此处需按照接口文档中的参数填写
    data = request_str + "&image=" + base64Data
    postData = {'data':base64.b64encode(data)} #双层base64加密
    req_json = json.dumps(postData) #转json格式
    req = urllib2.Request(url)
    req.add_header('Content-Type', 'application/json')
    response = urllib2.urlopen(req, req_json, 1000).read()
    res = json.loads(response)  
    #print res
    res1 = res['result']  
    res2 = base64.decodestring(res1) 
    print res2

    如果接口返回500错误,可能原因:鉴权失败。请前往鉴权失败排查,选择对应的鉴权方式做一步排查,其他状态码请参考下文解释。

    HTTP状态码详解

    状态码 含义
    100 客户端应当继续发送请求。这个临时响应是用来通知客户端它的部分请求已经被服务器接收,且仍未被拒绝。客户端应当继续发送请求的剩余部分,或者如果请求已经完成,忽略这个响应。服务器必须在请求完成后向客户端发送一个最终响应。
    101 服务器已经理解了客户端的请求,并将通过Upgrade 消息头通知客户端采用不同的协议来完成这个请求。在发送完这个响应最后的空行后,服务器将会切换到在Upgrade 消息头中定义的那些协议。   只有在切换新的协议更有好处的时候才应该采取类似措施。例如,切换到新的HTTP 版本比旧版本更有优势,或者切换到一个实时且同步的协议以传送利用此类特性的资源。
    102 由WebDAV(RFC 2518)扩展的状态码,代表处理将被继续执行。
    200 请求已成功,请求所希望的响应头或数据体将随此响应返回。
    201 请求已经被实现,而且有一个新的资源已经依据请求的需要而建立,且其 URI 已经随Location 头信息返回。假如需要的资源无法及时建立的话,应当返回 '202 Accepted'。
    202 服务器已接受请求,但尚未处理。正如它可能被拒绝一样,最终该请求可能会也可能不会被执行。在异步操作的场合下,没有比发送这个状态码更方便的做法了。   返回202状态码的响应的目的是允许服务器接受其他过程的请求(例如某个每天只执行一次的基于批处理的操作),而不必让客户端一直保持与服务器的连接直到批处理操作全部完成。在接受请求处理并返回202状态码的响应应当在返回的实体中包含一些指示处理当前状态的信息,以及指向处理状态监视器或状态预测的指针,以便用户能够估计操作是否已经完成。
    203 服务器已成功处理了请求,但返回的实体头部元信息不是在原始服务器上有效的确定集合,而是来自本地或者第三方的拷贝。当前的信息可能是原始版本的子集或者超集。例如,包含资源的元数据可能导致原始服务器知道元信息的超级。使用此状态码不是必须的,而且只有在响应不使用此状态码便会返回200 OK的情况下才是合适的。
    204 服务器成功处理了请求,但不需要返回任何实体内容,并且希望返回更新了的元信息。响应可能通过实体头部的形式,返回新的或更新后的元信息。如果存在这些头部信息,则应当与所请求的变量相呼应。   如果客户端是浏览器的话,那么用户浏览器应保留发送了该请求的页面,而不产生任何文档视图上的变化,即使按照规范新的或更新后的元信息应当被应用到用户浏览器活动视图中的文档。   由于204响应被禁止包含任何消息体,因此它始终以消息头后的第一个空行结尾。
    205 服务器成功处理了请求,且没有返回任何内容。但是与204响应不同,返回此状态码的响应要求请求者重置文档视图。该响应主要是被用于接受用户输入后,立即重置表单,以便用户能够轻松地开始另一次输入。   与204响应一样,该响应也被禁止包含任何消息体,且以消息头后的第一个空行结束。
    206 服务器已经成功处理了部分 GET 请求。类似于 FlashGet 或者迅雷这类的 HTTP 下载工具都是使用此类响应实现断点续传或者将一个大文档分解为多个下载段同时下载。   该请求必须包含 Range 头信息来指示客户端希望得到的内容范围,并且可能包含 If-Range 来作为请求条件。   响应必须包含如下的头部域:   Content-Range 用以指示本次响应中返回的内容的范围;如果是 Content-Type 为 multipart/byteranges 的多段下载,则每一 multipart 段中都应包含 Content-Range 域用以指示本段的内容范围。假如响应中包含 Content-Length,那么它的数值必须匹配它返回的内容范围的真实字节数。   Date   ETag 和/或 Content-Location,假如同样的请求本应该返回200响应。   Expires, Cache-Control,和/或 Vary,假如其值可能与之前相同变量的其他响应对应的值不同的话。   假如本响应请求使用了 If-Range 强缓存验证,那么本次响应不应该包含其他实体头;假如本响应的请求使用了 If-Range 弱缓存验证,那么本次响应禁止包含其他实体头;这避免了缓存的实体内容和更新了的实体头信息之间的不一致。否则,本响应就应当包含所有本应该返回200响应中应当返回的所有实体头部域。   假如 ETag 或 Last-Modified 头部不能精确匹配的话,则客户端缓存应禁止将206响应返回的内容与之前任何缓存过的内容组合在一起。   任何不支持 Range 以及 Content-Range 头的缓存都禁止缓存206响应返回的内容。
    207 由WebDAV(RFC 2518)扩展的状态码,代表之后的消息体将是一个XML消息,并且可能依照之前子请求数量的不同,包含一系列独立的响应代码。
    300 被请求的资源有一系列可供选择的回馈信息,每个都有自己特定的地址和浏览器驱动的商议信息。用户或浏览器能够自行选择一个首选的地址进行重定向。   除非这是一个 HEAD 请求,否则该响应应当包括一个资源特性及地址的列表的实体,以便用户或浏览器从中选择最合适的重定向地址。这个实体的格式由 Content-Type 定义的格式所决定。浏览器可能根据响应的格式以及浏览器自身能力,自动作出最合适的选择。当然,RFC 2616规范并没有规定这样的自动选择该如何进行。   如果服务器本身已经有了首选的回馈选择,那么在 Location 中应当指明这个回馈的 URI;浏览器可能会将这个 Location 值作为自动重定向的地址。此外,除非额外指定,否则这个响应也是可缓存的。
    301 被请求的资源已永久移动到新位置,并且将来任何对此资源的引用都应该使用本响应返回的若干个 URI 之一。如果可能,拥有链接编辑功能的客户端应当自动把请求的地址修改为从服务器反馈回来的地址。除非额外指定,否则这个响应也是可缓存的。   新的永久性的 URI 应当在响应的 Location 域中返回。除非这是一个 HEAD 请求,否则响应的实体中应当包含指向新的 URI 的超链接及简短说明。   如果这不是一个 GET 或者 HEAD 请求,因此浏览器禁止自动进行重定向,除非得到用户的确认,因为请求的条件可能因此发生变化。   注意:对于某些使用 HTTP/1.0 协议的浏览器,当它们发送的 POST 请求得到了一个301响应的话,接下来的重定向请求将会变成 GET 方式。
    302 请求的资源现在临时从不同的 URI 响应请求。由于这样的重定向是临时的,客户端应当继续向原有地址发送以后的请求。只有在Cache-Control或Expires中进行了指定的情况下,这个响应才是可缓存的。   新的临时性的 URI 应当在响应的 Location 域中返回。除非这是一个 HEAD 请求,否则响应的实体中应当包含指向新的 URI 的超链接及简短说明。   如果这不是一个 GET 或者 HEAD 请求,那么浏览器禁止自动进行重定向,除非得到用户的确认,因为请求的条件可能因此发生变化。   注意:虽然RFC 1945和RFC 2068规范不允许客户端在重定向时改变请求的方法,但是很多现存的浏览器将302响应视作为303响应,并且使用 GET 方式访问在 Location 中规定的 URI,而无视原先请求的方法。状态码303和307被添加了进来,用以明确服务器期待客户端进行何种反应。
    303 对应当前请求的响应可以在另一个 URI 上被找到,而且客户端应当采用 GET 的方式访问那个资源。这个方法的存在主要是为了允许由脚本激活的POST请求输出重定向到一个新的资源。这个新的 URI 不是原始资源的替代引用。同时,303响应禁止被缓存。当然,第二个请求(重定向)可能被缓存。   新的 URI 应当在响应的 Location 域中返回。除非这是一个 HEAD 请求,否则响应的实体中应当包含指向新的 URI 的超链接及简短说明。   注意:许多 HTTP/1.1 版以前的 浏览器不能正确理解303状态。如果需要考虑与这些浏览器之间的互动,302状态码应该可以胜任,因为大多数的浏览器处理302响应时的方式恰恰就是上述规范要求客户端处理303响应时应当做的。
    304 如果客户端发送了一个带条件的 GET 请求且该请求已被允许,而文档的内容(自上次访问以来或者根据请求的条件)并没有改变,则服务器应当返回这个状态码。304响应禁止包含消息体,因此始终以消息头后的第一个空行结尾。   该响应必须包含以下的头信息:   Date,除非这个服务器没有时钟。假如没有时钟的服务器也遵守这些规则,那么代理服务器以及客户端可以自行将 Date 字段添加到接收到的响应头中去(正如RFC 2068中规定的一样),缓存机制将会正常工作。   ETag 和/或 Content-Location,假如同样的请求本应返回200响应。   Expires, Cache-Control,和/或Vary,假如其值可能与之前相同变量的其他响应对应的值不同的话。   假如本响应请求使用了强缓存验证,那么本次响应不应该包含其他实体头;否则(例如,某个带条件的 GET 请求使用了弱缓存验证),本次响应禁止包含其他实体头;这避免了缓存了的实体内容和更新了的实体头信息之间的不一致。   假如某个304响应指明了当前某个实体没有缓存,那么缓存系统必须忽视这个响应,并且重复发送不包含限制条件的请求。   假如接收到一个要求更新某个缓存条目的304响应,那么缓存系统必须更新整个条目以反映所有在响应中被更新的字段的值。
    305 被请求的资源必须通过指定的代理才能被访问。Location 域中将给出指定的代理所在的 URI 信息,接收者需要重复发送一个单独的请求,通过这个代理才能访问相应资源。只有原始服务器才能建立305响应。   注意:RFC 2068中没有明确305响应是为了重定向一个单独的请求,而且只能被原始服务器建立。忽视这些限制可能导致严重的安全后果。
    306 在最新版的规范中,306状态码已经不再被使用。
    307 请求的资源现在临时从不同的URI 响应请求。由于这样的重定向是临时的,客户端应当继续向原有地址发送以后的请求。只有在Cache-Control或Expires中进行了指定的情况下,这个响应才是可缓存的。   新的临时性的URI 应当在响应的 Location 域中返回。除非这是一个HEAD 请求,否则响应的实体中应当包含指向新的URI 的超链接及简短说明。因为部分浏览器不能识别307响应,因此需要添加上述必要信息以便用户能够理解并向新的 URI 发出访问请求。   如果这不是一个GET 或者 HEAD 请求,那么浏览器禁止自动进行重定向,除非得到用户的确认,因为请求的条件可能因此发生变化。
    400 1、语义有误,当前请求无法被服务器理解。除非进行修改,否则客户端不应该重复提交这个请求。   2、请求参数有误。
    401 当前请求需要用户验证。该响应必须包含一个适用于被请求资源的 WWW-Authenticate 信息头用以询问用户信息。客户端可以重复提交一个包含恰当的 Authorization 头信息的请求。如果当前请求已经包含了 Authorization 证书,那么401响应代表着服务器验证已经拒绝了那些证书。如果401响应包含了与前一个响应相同的身份验证询问,且浏览器已经至少尝试了一次验证,那么浏览器应当向用户展示响应中包含的实体信息,因为这个实体信息中可能包含了相关诊断信息。参见RFC 2617。
    402 该状态码是为了将来可能的需求而预留的。
    403 服务器已经理解请求,但是拒绝执行它。与401响应不同的是,身份验证并不能提供任何帮助,而且这个请求也不应该被重复提交。如果这不是一个 HEAD 请求,而且服务器希望能够讲清楚为何请求不能被执行,那么就应该在实体内描述拒绝的原因。当然服务器也可以返回一个404响应,假如它不希望让客户端获得任何信息。
    404 请求失败,请求所希望得到的资源未被在服务器上发现。没有信息能够告诉用户这个状况到底是暂时的还是永久的。假如服务器知道情况的话,应当使用410状态码来告知旧资源因为某些内部的配置机制问题,已经永久的不可用,而且没有任何可以跳转的地址。404这个状态码被广泛应用于当服务器不想揭示到底为何请求被拒绝或者没有其他适合的响应可用的情况下。
    405 请求行中指定的请求方法不能被用于请求相应的资源。该响应必须返回一个Allow 头信息用以表示出当前资源能够接受的请求方法的列表。   鉴于 PUT,DELETE 方法会对服务器上的资源进行写操作,因而绝大部分的网页服务器都不支持或者在默认配置下不允许上述请求方法,对于此类请求均会返回405错误。
    406 请求的资源的内容特性无法满足请求头中的条件,因而无法生成响应实体。   除非这是一个 HEAD 请求,否则该响应就应当返回一个包含可以让用户或者浏览器从中选择最合适的实体特性以及地址列表的实体。实体的格式由 Content-Type 头中定义的媒体类型决定。浏览器可以根据格式及自身能力自行作出最佳选择。但是,规范中并没有定义任何作出此类自动选择的标准。
    407 与401响应类似,只不过客户端必须在代理服务器上进行身份验证。代理服务器必须返回一个 Proxy-Authenticate 用以进行身份询问。客户端可以返回一个 Proxy-Authorization 信息头用以验证。参见RFC 2617。
    408 请求超时。客户端没有在服务器预备等待的时间内完成一个请求的发送。客户端可以随时再次提交这一请求而无需进行任何更改。
    409 由于和被请求的资源的当前状态之间存在冲突,请求无法完成。这个代码只允许用在这样的情况下才能被使用:用户被认为能够解决冲突,并且会重新提交新的请求。该响应应当包含足够的信息以便用户发现冲突的源头。   冲突通常发生于对 PUT 请求的处理中。例如,在采用版本检查的环境下,某次 PUT 提交的对特定资源的修改请求所附带的版本信息与之前的某个(第三方)请求向冲突,那么此时服务器就应该返回一个409错误,告知用户请求无法完成。此时,响应实体中很可能会包含两个冲突版本之间的差异比较,以便用户重新提交归并以后的新版本。
    410 被请求的资源在服务器上已经不再可用,而且没有任何已知的转发地址。这样的状况应当被认为是永久性的。如果可能,拥有链接编辑功能的客户端应当在获得用户许可后删除所有指向这个地址的引用。如果服务器不知道或者无法确定这个状况是否是永久的,那么就应该使用404状态码。除非额外说明,否则这个响应是可缓存的。   410响应的目的主要是帮助网站管理员维护网站,通知用户该资源已经不再可用,并且服务器拥有者希望所有指向这个资源的远端连接也被删除。这类事件在限时、增值服务中很普遍。同样,410响应也被用于通知客户端在当前服务器站点上,原本属于某个个人的资源已经不再可用。当然,是否需要把所有永久不可用的资源标记为'410 Gone',以及是否需要保持此标记多长时间,完全取决于服务器拥有者。
    411 服务器拒绝在没有定义 Content-Length 头的情况下接受请求。在添加了表明请求消息体长度的有效 Content-Length 头之后,客户端可以再次提交该请求。
    412 服务器在验证在请求的头字段中给出先决条件时,没能满足其中的一个或多个。这个状态码允许客户端在获取资源时在请求的元信息(请求头字段数据)中设置先决条件,以此避免该请求方法被应用到其希望的内容以外的资源上。
    413 服务器拒绝处理当前请求,因为该请求提交的实体数据大小超过了服务器愿意或者能够处理的范围。此种情况下,服务器可以关闭连接以免客户端继续发送此请求。   如果这个状况是临时的,服务器应当返回一个 Retry-After 的响应头,以告知客户端可以在多少时间以后重新尝试。
    414 请求的URI 长度超过了服务器能够解释的长度,因此服务器拒绝对该请求提供服务。这比较少见,通常的情况包括:   本应使用POST方法的表单提交变成了GET方法,导致查询字符串(Query String)过长。   重定向URI “黑洞”,例如每次重定向把旧的 URI 作为新的 URI 的一部分,导致在若干次重定向后 URI 超长。   客户端正在尝试利用某些服务器中存在的安全漏洞攻击服务器。这类服务器使用固定长度的缓冲读取或操作请求的 URI,当 GET 后的参数超过某个数值后,可能会产生缓冲区溢出,导致任意代码被执行[1]。没有此类漏洞的服务器,应当返回414状态码。
    415 对于当前请求的方法和所请求的资源,请求中提交的实体并不是服务器中所支持的格式,因此请求被拒绝。
    416 如果请求中包含了 Range 请求头,并且 Range 中指定的任何数据范围都与当前资源的可用范围不重合,同时请求中又没有定义 If-Range 请求头,那么服务器就应当返回416状态码。   假如 Range 使用的是字节范围,那么这种情况就是指请求指定的所有数据范围的首字节位置都超过了当前资源的长度。服务器也应当在返回416状态码的同时,包含一个 Content-Range 实体头,用以指明当前资源的长度。这个响应也被禁止使用 multipart/byteranges 作为其 Content-Type。
    417 在请求头 Expect 中指定的预期内容无法被服务器满足,或者这个服务器是一个代理服务器,它有明显的证据证明在当前路由的下一个节点上,Expect 的内容无法被满足。
    421 从当前客户端所在的IP地址到服务器的连接数超过了服务器许可的最大范围。通常,这里的IP地址指的是从服务器上看到的客户端地址(比如用户的网关或者代理服务器地址)。在这种情况下,连接数的计算可能涉及到不止一个终端用户。
    422 从当前客户端所在的IP地址到服务器的连接数超过了服务器许可的最大范围。通常,这里的IP地址指的是从服务器上看到的客户端地址(比如用户的网关或者代理服务器地址)。在这种情况下,连接数的计算可能涉及到不止一个终端用户。
    422 请求格式正确,但是由于含有语义错误,无法响应。(RFC 4918 WebDAV)423 Locked   当前资源被锁定。(RFC 4918 WebDAV)
    424 由于之前的某个请求发生的错误,导致当前请求失败,例如 PROPPATCH。(RFC 4918 WebDAV)
    425 在WebDav Advanced Collections 草案中定义,但是未出现在《WebDAV 顺序集协议》(RFC 3658)中。
    426 客户端应当切换到TLS/1.0。(RFC 2817)
    449 由微软扩展,代表请求应当在执行完适当的操作后进行重试。
    500 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。一般来说,这个问题都会在服务器的程序码出错时出现。
    501 服务器不支持当前请求所需要的某个功能。当服务器无法识别请求的方法,并且无法支持其对任何资源的请求。
    502 作为网关或者代理工作的服务器尝试执行请求时,从上游服务器接收到无效的响应。
    503 由于临时的服务器维护或者过载,服务器当前无法处理请求。这个状况是临时的,并且将在一段时间以后恢复。如果能够预计延迟时间,那么响应中可以包含一个 Retry-After 头用以标明这个延迟时间。如果没有给出这个 Retry-After 信息,那么客户端应当以处理500响应的方式处理它。   注意:503状态码的存在并不意味着服务器在过载的时候必须使用它。某些服务器只不过是希望拒绝客户端的连接。
    504 作为网关或者代理工作的服务器尝试执行请求时,未能及时从上游服务器(URI标识出的服务器,例如HTTP、FTP、LDAP)或者辅助服务器(例如DNS)收到响应。   注意:某些代理服务器在DNS查询超时时会返回400或者500错误
    505 服务器不支持,或者拒绝支持在请求中使用的 HTTP 版本。这暗示着服务器不能或不愿使用与客户端相同的版本。响应中应当包含一个描述了为何版本不被支持以及服务器支持哪些协议的实体。
    506 由《透明内容协商协议》(RFC 2295)扩展,代表服务器存在内部配置错误:被请求的协商变元资源被配置为在透明内容协商中使用自己,因此在一个协商处理中不是一个合适的重点。
    507 服务器无法存储完成请求所必须的内容。这个状况被认为是临时的。WebDAV (RFC 4918)
    509 服务器达到带宽限制。这不是一个官方的状态码,但是仍被广泛使用。
    510 获取资源所需要的策略并没有没满足。(RFC 2774)

    十、运维

    您可以前往「私有化部署服务」/「常见问题」查找常见问题排查思路

    您可以前往 「私有化部署服务」/「运维手册」查看常用运维文档

    上一篇
    部署前环境检查(必看)
    下一篇
    iOCR自定义平台部署