华为云用户手册

系统管理-产品管理 接入全景式业务风控系统的前提是需要先创建产品, 系统会分配 appId和appSecret. 这两个参数标识一个应用, 也贯穿整个风控体系, 包括事件, 字段, 指标, 策略等, 就算是调用风控任何一个接口都需要对appId和appSecret进行鉴权。 新增 单击“新建产品”按钮，即可看到如下图所示的“新增产品”页，如下图所示： 图81 新增产品 依次填写产品的信息，单击“确定”按钮即可新增产品信息。 编辑 单击产品管理列表中的操作列的编辑“”按钮，即可进入“编辑产品”页面： 图82 编辑产品 在此页面中可对产品名、作用范围、描述进行编辑，单击“确定”即可将信息更新到该产品信息中，单击“取消”数据无变化。 删除 在产品管理列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“确定删除该产品吗？” 图83 删除产品

部门管理 超级管理员可访问此模块，创建不同的部门。不同部门的产品、事件、字段、指标、策略等数据，相对独立，仅限于本部门员工可见，但名单、风险类型、函数、模型等数据所有部门可以共享。 图91 部门管理 新增：单击“添加部门”按钮，即可看到如下图所示的“添加部门”页，如下图所示： 图92 添加部门 填写部门名称信息，单击“确定”按钮即可新增部门信息。 编辑：单击部门管理列表中的操作列的编辑“”按钮，即可进入“编辑部门”页面： 图93 编辑部门 在此页面中可对部门名进行编辑，单击“确定”即可将信息更新到该产品信息中，单击“取消”数据无变化。 删除：在产品管理列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“确定删除该部门吗？”单击“取消”按钮，该数据不做任何操作，单击“确定”按钮，删除该部门信息，并给出提示“删除成功”； 图94 删除部门

账号管理 查询：账号管理列表默认按照最后登录时间倒序排序，可根据“账号昵称”、“所属部门”、“角色”进行查询； 新增：系统管理员可以添加不同角色的账号，以方便不同业务部门登录风控平台进行相关操作。新增的账号默认为“启用”状态； 图84 添加账号 编辑：在账号管理列表，单击操作列的编辑“”按钮，弹出编辑账号页面，可支持编辑昵称、登录密码、角色、所属部门、状态（启用/停用）等信息；其中登录名不可以编辑。单击“提交”按钮即可编辑成功； 图85 编辑账号

数据报表 请求趋势统计 展示总请求量、正常请求量、疑似请求量、风险请求量的趋势统计，最多可查询近180天的数据。支持不同时间段的请求趋势的对比和数据报表的导出操作。 图73 请求趋势统计 业务异常统计 可查看请求总量、设备指纹缺失情况、IP缺失情况和策略通过情况。 图74 业务异常监控 事件策略统计 可按事件查询近180天的请求分布情况，包括请求数、疑似风险数及占比，风险数及占比情况；也可从策略维度查询策略的触发率、命中情况、疑似风险、风险数等信息。查询结果支持导出。 图75 事件策略统计 策略流程波动统计 统计每个策略或策略节点的执行请求量，可按同事件下策略的执行顺序查看每个策略的执行量，也可按流程策略中节点的执行顺序查看每个节点的执行量；查询结果支持导出。 图76 策略流程波动统计 规则命中统计 可查看每条规则的执行总量、通过总量、命中总量和命中率，查询结果支持导出。 图77 规则命中统计 风险类型统计 统计风险请求对应的风险类型的命中情况，查询结果支持导出。 图78 风险类型统计

变量管理 字段管理 字段是用于判断和识别风险的最小单位，例如ID、IP地址、 账号、设备指纹等，配置指标、策略时都将用到字段。 字段分成系统字段和自定义字段，系统字段不可以编辑和删除。 新增 支持批量导入或手动新增字段，手动新建/编辑字段时，可使用函数计算公式，使用复杂表达式定义函数字段。 系统内已有预置分类，也可单击“字段分类管理”创建自定义分类，在规则中使用字段时可通过分类筛选字段，方便选择。 在字段管理页面单击“添加字段”按钮，弹出添加字段页面，如下图所示： 图11 手动新增字段 依次填写字段的信息，信息填写完整后，单击“确定”按钮即可新增字段信息，并提示“新增成功”信息； 图12 新增字段成功 编辑 单击字段管理列表中的操作列的编辑“”按钮，即可进入“编辑字段”页面（未审核通过字段不可编辑），如下图所示： 字段信息中除了“字段code”、“数据类型”、“所属部门”不可编辑，其它信息都可以编辑，单击“提交”按钮即可编辑成功； 图13 编辑字段 删除 在字段管理列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“确定删除该字段吗？” 图14 删除字段1 单击“取消”按钮，该数据不做任何操作，单击“确定”按钮，页面上方提示“您的操作已提交审核，审核通过后生效”；并在该产品数据的最左侧有“待审核”标签。 图15 删除字段2 名单管理 用户可以自定义名单并上传数据，名单数据支持增删改查的操作，在风控策略中可以使用名单数据。 新增 添加名单：单击名单管理列表右上方的“添加名单”，弹出“添加名单”页面，如下图所示 图16 添加名单 相关信息填写完整好，单击“提交”，弹出“新增成功”信息；新增的字段默认为“生效”状态； 图17 名单新增成功 添加名单数据-文件上传：根据“模板文件”示例，添加名单数据在文件中，并导入到系统中即可批量上传名单数据； 图18 添加名单数据-文件上传 添加名单数据-手动录入：可手动逐条添加名单数据信息，并可约束名单数据的效期； 图19 添加名单数据-手动录入 编辑 在名单管理列表中，单击操作列的编辑“”按钮，即可进入“编辑名单”页面，名单的编辑支持对名单的“基本信息”和“名单数据”的编辑，如下图所示： 图20 基本信息 图21 名单数据 删除 在名单管理列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“确定删除该字段吗？” 图22 名单删除警告 单击“取消”按钮，该数据不做任何操作，单击“确定”按钮，页面上方提示“名单删除成功”； 图23 名单删除提示 函数管理 可管理风控系统中的函数，支持增、删、改、查操作。 新增 单击函数管理列表右上方的“新建函数”，弹出“新增函数”页面，如下图所示： 图24 新增函数 图25 编辑函数 所有函数为全部部门可见，添加函数时无需选择函数的所属部门; 单击“提交”按钮，函数新增成功，单击“取消”按钮，数据无变化； 图26 函数管理 编辑 在函数管理列表中，单击操作列的编辑“”按钮，即可进入“编辑函数”页面，函数的编辑支持对函数的“基本信息”和“名单数据”的编辑，如下图所示： 图27 函数基本信息 图28 函数名单列表 删除 图29 删除函数 风险类型管理 根据业务场景定义不同的风险类型并在策略中使用，命中后可在总览里根据风险类型来查询风险分类趋势。可管理风控系统中的风险类型，支持增、删、改、查操作。 新增 在风险类型管理，单击“添加风险类型”按钮，输入分类名称后即可自定义风险分类； 图30 添加风险 图31 风险类型管理 编辑 单击风险类型管理列表中的操作列的编辑“”按钮，即可进入“编辑风险”页面，支持对风险的“名称”“使用事件”“描述”进行编辑，不支持“CODE”和“所属部门”的编辑； 图32 编辑风险 单击“确定”按钮，编辑成功的风险类型需要“审核”通过后才能生效； 图33 编辑风险提示 删除 在风险类型管理列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“您确定删除该风险类型吗？” 图34 删除风险类型警告 单击“确定”按钮，删除的数据需要提交审核，根据审核的状态来决定该条数据是否删除； 图35 删除风险类型提示 指标中心 可管理风控系统中的指标，查看指标的调用统计，新建指标计算方式。 指标调用统计 定义完成的指标有数据接入后，在此模块就可以看到指标的调用统计信息，包括指标调用趋势图、调用排行、接口调用量等信息。 指标定义 新增：在指标定义页面，单击“添加指标”按钮，弹出“添加指标”页面；新建指标时，需选择指标的计算事件； 图36 添加指标 编辑：单击指标定义列表中的操作列的编辑“”按钮，即可进入“编辑指标”页面，除了指标的“所属部门”无法编辑，其他字段都支持编辑； 图37 编辑指标 删除：在指标定义列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“您确认执行删除操作吗？” 单击“取消”按钮，该指标数据无变化；单击“确定”按钮，指标，待删除的数据需要提交审核，审核通过，则删除成功；审核拒绝，则删除失败； 图38 删除指标 计算方式管理 计算方式是指标里使用到的，系统里内置了常用的关联、统计、方差等计算方式，在此功能模块可以对系统内置的计算方式和新建的计算方式来查询。 新增：计算方式是指标里使用到的，系统里内置了常用的关联、统计、方差等计算方式，也支持自定义计算方式，在“计算方式管理”界面，单击“添加计算方式”按钮，弹出如下图： 图39 添加计算方式 在页面弹出框，依次填写计算方式名称、Code、数据类型、返回类型、描述、脚本，单击“确定”按钮完成指标的定义，添加后即时生效。 编辑：在“计算方式管理”界面，在每条计算方式数据的操作栏，编辑“”按钮，弹出“编辑计算方式”页面，支持对计算方式的名称、数据类型、描述、脚本进行修改，如下图： 图40 编辑计算方式 删除：在计算方式管理列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“您确认执行删除操作吗？” 图41 删除计算方式 数据聚合 可管理外部数据和管理外部数据映射，支持对外部数据及其映射进行增、删、改、查的操作。 三方数据源 列表展示已添加的所有三方数据源，支持查看、编辑、删除和添加新的三方数据源。 新增：在“三方数据源”的列表中，单击【添加三方数据源】按钮，可设置数据源的基本信息、计费方式、费用和参数等。 图42 添加三方数据源1 图43 添加三方数据源2 外部数据创建完成后可添加映射，将外部数据的入参与风控系统内的字段进行映射，映射完成后可在策略中使用此外部数据。 编辑：在三方数据源列表中，单击操作列的编辑“”按钮，弹出“编辑三方数据源”页面，除“数据源code”无法编辑，其他数据都可以进行编辑； 图44 编辑三方数据源 单击【确定】，数据提交审核，审核通过后修改的数据方可生效，否则数据不生效。 删除：在“三方数据”列表界面，单击操作列的删除“”按钮，弹出提示页面，如下图： 图45 删除三方数据源 单击【确定】删除成功，单击【取消】数据无变化； 行内数据源 列表展示已添加的所有行内数据源，支持查看、编辑、删除和添加新的行内数据源。 新增：行内的数据源可以通过添加数据源的方式与风控对接。 行内数据源的添加分为两部分，一部分为基本信息的输入；第二部分需要设置三方数据源的入参和出参，设置完即可在策略中使用。 单击“行内数据源”菜单，进入页面，单击页面右上角“添加行内数据源”按钮； 在页面弹出框，依次填写数据名称、Code，选择状态、来源数据库、缓存时间，设置入参； 编辑：在行内数据源列表中，单击操作列的编辑“”按钮，弹出“编辑行内数据源”页面，除“数据源code”无法修改，其他数据都可以进行修改； 删除：在“行内数据”列表界面，单击操作列的删除“”按钮，弹出提示页面，如下图： 图46 删除确认 单击【确定】删除成功，单击【取消】数据无变化； 如果该数据源已经被使用，则无法删除；需要解除该数据源的使用才可以删除； 映射管理 无论是SAAS数据源还是行内数据源，在数据源添加到系统后，需要将数据源的入参与风控的字段做映射后才可使用。 新增映射：单击“映射管理”菜单，进入页面；列表中每条数据源的最右侧有操作栏，单击操作栏的“添加映射”操作，弹出“添加映射”页面； 添加映射时需设置映射名称、映射可见范围，将数据源的入参和系统字段进行映射，映射完成后即可在策略中使用此数据源； 依次输入“映射名称”，选择“所属部门”，选择“使用事件”，列表下方显示事件下的字段，选择字段后，单击“确定”按钮，完成字段映射。 图47 字段映射1 图48 字段映射2 编辑映射：在“映射管理”列表中，单击操作列的编辑“”按钮，弹出“编辑行内数据源”页面，除“数据源”和“所属部门”无法修改，其他数据都可以进行修改； 图49 编辑映射 删除映射组件管理 组件可以在策略的条件、动作中使用，提升策略的配置效率，提高复用性。支持对组件进行新建、编辑、删除、复制、导入导出等操作。 新增：在“组件管理”列表界面，单击【新建组件】按钮，跳转到“新建组件”界面，如下图所示： 图50 新建组件1 依次输入组件名称，选择组件模式、组件分类、状态，配置条件与动作，最后单击“确定”按钮完成组件的创建。 图51 新建组件2 组件模式包括规则匹配、风险权重、自定义规则、评分卡、基础决策表、决策矩阵、决策树、规则、动作多种类型，操作员可根据业务需要选择对应的组件模式进行配置。 图52 新建组件3 编辑：在“组件管理”列表中，单击操作列的编辑“”按钮，弹出“编辑组件”页面，除“组件模式”和“所属部门”无法修改，其他数据都可以进行修改； 图53 编辑组件 删除：在“组件管理”列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“您确认删除该组件？” 图54 删除组件 策略管理 用户可根据业务需求自定义策略并对策略信息进行维护，支持按目录管理策略，可查看产品、事件、策略的层级关系，支持通过目录快速定位到策略及策略节点查看详情。 图55 策略管理 新建策略时，可设置策略名称、所属产品和关联事件、优先级、状态、策略模式等基本信息和策略配置详情。也可通过复制功能复制已有的策略并在原策略的基础上进行修改生成新的策略。 图56 开户策略 新增策略 在“策略管理”列表界面，单击“新建策略”按钮，跳转到“新建策略”页面，如下所示： 图57 策略管理-新建策略 图58 新建策略 编辑策略 在“策略管理”列表界面，每条策略数据的右侧，单击操作栏的编辑“”按钮，跳转到策略的编辑页面，如下所示： 图59 编辑策略1 图60 编辑策略2 删除策略 在“策略管理”列表中，单击操作列的删除“”按钮，弹出警告，并给出提示“您确认删除该组件？” 图61 删除策略警告 单击【取消】按钮，该指标数据无变化；单击【确定】按钮，指标，待删除的数据需要提交审核，审核通过，则删除成功；审核拒绝，则删除失败； 图62 删除策略提示 导入导出 支持将系统内的策略导出后进行同系统/跨系统导入。 图63 导出策略 导入时需上传导入文件、选择文件导入的产品和事件，确认导入数据（包括策略、字段、指标、外部数据、名单、函数、模型等）并审核通过后即可在系统中查看策略。 策略模板 支持创建策略模板并对策略模板进行分类管理，支持单条、批量导入和导出策略模板。 图64 策略模板 新建策略模板时，模板基本信息为必输项，规则信息和流程概览中的内容无需配置完整。在创建策略时可引用策略模板后，在此基础上进行完善，将策略配置完整。 策略实验室 策略实验室主要用于策略调优，实验室的策略支持用户手动新建，也可引用线上策略。调优后的策略可复制到线上去运行。 图65 策略实验室 查看实验 在“策略实验室”界面，支持根据策略的“所属产品”、“关联事件”、“试验项名称”条件进行筛选查询试验项； 图66 试验项列表 在每条试验项的操作栏，单击“”按钮，可支持查看试验项下策略的详细信息；并支持查看、编辑和删除每条策略；也可支持“引用线上策略”和“新建试验策略”； 图67 策略列表 开始实验 可在“策略实验室”界面，在试验列表中选择需要执行的试验项，并单击操作列的“”按钮，跳转到配置“试验数据源”页面； 支持选择线上实时数据、线上历史数据或自定义数据（多笔、单笔）、测试案例管理多种数据源对策略进行试验。查看试验结果时，操作员可选择不同的查询维度（策略、节点）查看不同的报表项，也支持查看试验策略的执行详情和决策结果。 图68 自定义数据 如果选择“线上数据”，单击【开始试验】按钮，即可查看线上数据在该试验项下的“风险趋势统计”和“执行详情”的情况； 选择是否保留结果（线上实时数据除外），可以保留本次结果的报告。在试验室列表可以查看试验结果。 图69 线上历史数据

监控中心 业务监控 请求事件监控 查询系统的风控引擎风险识别日志，及时了解业务系统的风险情况和定位风险源头及数据回放，查看策略的执行结果，支持通过各类查询条件组合进行筛选。 通过设置查询条件，可从不同维度对请求结果进行筛选，查询结果列表的展示会随查询条件的维度而变化，可从请求、策略、节点、规则等维度展示列表信息，也支持设置高级查询条件。 图3 请求事件监控 查询结果列表中可查看每笔请求对应的事件详情信息，包括风险等级、风险类型、各类参数等信息 数据报告管理 系统可以自动发送设置周期内的风险报告邮件，可以不通过访问总览，通过邮件了解日常风险情况，报告的维度包括风险趋势、风险分类占比、每日风险详情。 图4 添加数据报告 风险监控管理 该功能支持对不同产品、事件下的业务情况进行监控，包括请求总量、正常请求量、风险请求量、疑似风险请求量进行监控，可以按分钟、小时、天进行高于、低于等百分比进行监控设置，超过设定的条件后，系统将发送报警通知到设定的邮箱。 图5 添加监控 系统监控 应用节点监控 监控指标、设备指纹、引擎的节点状态，支持对近7天的监控情况进行查询。 图6 应用节点监控 服务器性能监控 监控服务器的CPU使用率、内存使用率、负载状态、网络状态、存储状态、磁盘IO使用率。 图7 服务器性能监控 接口调用监控 监控引擎的风险识别接口执行情况和调用错误趋势，设备指纹接口执行响应情况和调用错误趋势，指标接口的执行响应情况，支持对近7天的监控情况进行查询。 图8 接口调用监控 中间件监控 系统展示Redis、Mongo、ES、MySQL的监控，包括慢查询、连接数、节点状态等； 图9 中间件监控 监控报警管理 该功能可以查询到应用节点、服务器性能、接口、中间件触发的报警，触发后以折线图及列表的形式展示报警信息及出发详情。 单击“监控报警管理”，进入页面后，系统会默认近6个小时的情况。 图10 监控报警管理

安全组规则修改（可选） 安全组实际是网络流量访问策略，包括网络流量入方向规则和出方向规则，通过这些规则为安全组内具有相同保护需求并且相互信任的云服务器、云容器、云数据库等实例提供安全保护。 如果您的实例关联的安全组策略无法满足使用需求，比如需要添加、修改、删除某个TCP端口，请参考以下内容进行修改。 添加安全组规则：根据业务使用需求需要开放某个TCP端口，请参考添加安全组规则添加入方向规则，打开指定的TCP端口。 修改安全组规则：安全组规则设置不当会造成严重的安全隐患。您可以参考修改安全组规则，来修改安全组中不合理的规则，保证云服务器等实例的网络安全。 删除安全组规则：当安全组规则入方向、出方向源地址/目的地址有变化时，或者不需要开放某个端口时，您可以参考删除安全组规则进行安全组规则删除。

方案架构 该解决方案支持一键式部署 云防火墙 CFW、 企业主机安全 HSS、web应用防火墙 WAF、 云堡垒机CBH 、数据库安全审计DBSS等服务，帮助用户快速在华为云上搭建等保三级合规安全解决方案，轻松满足等保三级合规要求。 方案部署架构如下图所示： 图1 方案架构图 该解决方案会部署如下资源： Web应用防火墙 WAF：用来对业务流量进行多维度检测和防护。 企业主机安全HSS：用来提升主机整体安全性，提供资产管理、漏洞管理、入侵检测、基线检查等功能，帮助企业降低主机安全风险。 云证书管理服务 CCM：实现网站的可信身份认证与安全数据传输。 安全云脑 SecMaster用来对攻击事件、威胁告警和攻击源头进行分类统计和综合分析，为用户呈现出全局安全攻击态势；识别云服务日志中的潜在威胁，并对检测出的威胁告警进行统计。 云防火墙CFW：实现对云上互联网边界流量实时入侵检测与防御。 云堡垒机 CBH：集中管控运维管理人员实现操作可审计、可管控、可合规且高效运维。 数据库安全审计DBSS：对数据库的行为进行操作审计，及时发现降低数据库泄露风险。 漏洞管理服务 CodeArts Inspector：及时发现业务系统存在的漏洞，发现问题及时修复降低风险。 此外，您可以通过使用 云监控服务 来监测弹性云服务器运行状态；通过购买 云日志 服务，对日志数据进行备份；开启 云审计 功能对云平台操作进行业务审计。

安全组规则修改（可选） 安全组实际是网络流量访问策略，包括网络流量入方向规则和出方向规则，通过这些规则为安全组内具有相同保护需求并且相互信任的云服务器、云容器、云数据库等实例提供安全保护。 如果您的实例关联的安全组策略无法满足使用需求，比如需要添加、修改、删除某个TCP端口，请参考以下内容进行修改。 添加安全组规则：根据业务使用需求需要开放某个TCP端口，请参考添加安全组规则添加入方向规则，打开指定的TCP端口。 修改安全组规则：安全组规则设置不当会造成严重的安全隐患。您可以参考修改安全组规则，来修改安全组中不合理的规则，保证云服务器等实例的网络安全。 删除安全组规则：当安全组规则入方向、出方向源地址/目的地址有变化时，或者不需要开放某个端口时，您可以参考删除安全组规则进行安全组规则删除。

安全组规则修改（可选） 该解决方案使用22端口用来远程登录弹性云服务器 E CS ，默认对该方案创建的VPC子网网段放开，请参考修改安全组规则，配置IP地址白名单，以便能正常访问服务。 安全组实际是网络流量访问策略，包括网络流量入方向规则和出方向规则，通过这些规则为安全组内具有相同保护需求并且相互信任的云服务器、云容器、云数据库等实例提供安全保护。 如果您的实例关联的安全组策略无法满足使用需求，比如需要添加、修改、删除某个TCP端口，请参考以下内容进行修改。 添加安全组规则：根据业务使用需求需要开放某个TCP端口，请参考添加安全组规则添加入方向规则，打开指定的TCP端口。 修改安全组规则：安全组规则设置不当会造成严重的安全隐患。您可以参考修改安全组规则，来修改安全组中不合理的规则，保证云服务器等实例的网络安全。 删除安全组规则：当安全组规则入方向、出方向源地址/目的地址有变化时，或者不需要开放某个端口时，您可以参考删除安全组规则进行安全组规则删除。

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

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

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

约束与限制 该解决方案部署前，需 注册华为账号 并开通华为云，完成实名认证，且账号不能处于欠费或冻结状态。如果计费模式选择“包年包月”，请确保账户余额充足以便一键部署资源的时候可以自动支付；或者在一键部署的过程进入费用中心，找到“待支付订单”并手动完成支付。 该解决方案部署成功后，Zabbix环境初始化大约用时5分钟左右，受弹性云服务器 ECS规格以及网络带宽的影响会有波动，完成后方可参考开始使用进行验证。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询服务的终端节点。 对象存储迁移 服务的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。 表1 对象存储迁移服务的终端节点 区 域名 称 区域 终端节点 华北-北京一 cn-north-1 oms.cn-north-1.myhuaweicloud.com 华北-北京四 cn-north-4 oms.cn-north-4.myhuaweicloud.com 华东-上海二 cn-east-2 oms.cn-east-2.myhuaweicloud.com 华东-上海一 cn-east-3 oms.cn-east-3.myhuaweicloud.com 华东二 cn-east-4 oms.cn-east-4.myhuaweicloud.com 华南-广州 cn-south-1 oms.cn-south-1.myhuaweicloud.com 中国-香港 ap-southeast-1 oms.ap-southeast-1.myhuaweicloud.com 亚太-新加坡 ap-southeast-3 oms.ap-southeast-3.myhuaweicloud.com 华南-广州-友好用户环境 cn-south-4 oms.cn-south-4.myhuaweicloud.com 拉美-圣地亚哥 la-south-2 oms.la-south-2.myhuaweicloud.com 西南-贵阳一 cn-southwest-2 oms.cn-southwest-2.myhuaweicloud.com 华北-乌兰察布一 cn-north-9 oms.cn-north-9.myhuaweicloud.com 亚太-曼谷 ap-southeast-2 oms.ap-southeast-2.myhuaweicloud.com 拉美-墨西哥城二 la-north-2 oms.la-north-2.myhuaweicloud.com 土耳其-伊斯坦布尔 tr-west-1 oms.tr-west-1.myhuaweicloud.com 拉美-圣保罗一 sa-brazil-1 oms.sa-brazil-1.myhuaweicloud.com 亚太-雅加达 ap-southeast-4 oms.ap-southeast-4.myhuaweicloud.com 中东-利雅得 me-east-1 oms.me-east-1.myhuaweicloud.com 非洲-约翰塔斯堡 af-south-1 oms.af-south-1.myhuaweicloud.com 亚太-马尼拉 ap-southeast-5 oms.ap-southeast-5.myhuaweicloud.com

迁移失败原因 失败原因编码 失败原因 处理措施 TRF.0001 系统内部异常。 请单击重启按钮尝试重启迁移任务。 TRF.0003 迁移任务等待超时。 请单击重启按钮尝试重启迁移任务。 TRF.0012 任务参数校验失败。 请确认在所选择的迁移方式下对象存在。 TRF.0013 任务参数校验失败。 请确保对象列表文件存在且可以正常获取（具有读写权限）。 TRF.0014 任务参数校验失败。 请确保对象列表文件为大小不超过100MB的“.txt”文件。 TRF.0015 源端账户不具有BLOB服务，无法实施迁移。 请重新输入可用的源端账户。 TRF.0016 URL列表文件格式错误。 请参照用户指南检查URL列表文件格式，或者联系技术支持。 TRF.0017 指定的列表文件为空。 请检查列表文件。 TRF.0018 任务参数校验失败。 请确保对象列表文件中每一行的长度都不超过65535。 TRF.0019 任务参数校验失败。 请确保对象列表文件的metaData中contentType为text/plain、且不能设置contentEncoding。 TRF.0051 您输入的AK/SK无足够权限访问目的端桶或者对象。 请确认AK/SK有足够权限后重试。 TRF.0052 您输入的AK/SK无足够权限访问目的端桶或者对象。 请确认AK/SK有足够权限后重试。 TRF.0053 由于您的账号状态异常（过期或已被冻结）导致迁移操作无法完成。 请联系客服确认账号状态。 TRF.0054 您输入的AK/SK无足够权限访问目的端桶或者对象。 请确认AK/SK有足够权限后重试。 TRF.0055 目的端桶的剩余空间不足。 请确认该桶具有充足空间后重试。 TRF.0056 您的迁移账户已被冻结。 请解冻后重试。 TRF.0057 您输入的AK/SK无效。 请输入正确AK/SK后重试。 TRF.0058 目的端桶不存在（迁移过程中请勿修改目的端桶或者对象的访问权限）。 请确认桶名正确后重试。 TRF.0059 目的端对象不存在（迁移过程中请勿修改目的端桶或者对象的访问权限）。 请确认桶名或对象名正确后重试。 TRF.0060 用于存储迁移对象的路径太长。 请更改要迁移的对象的名称或路径。 TRF.0061 目的端 对象存储服务 异常。 请稍后重试，或者联系技术支持。 TRF.0062 部分对象上传失败。 请确认没有其他迁移同名对象的任务后重试。 TRF.0063 由于账号余额不足，无法上传OBS导致迁移任务失败。 请检查账户余额或联系客服。 TRF.0151 源端AK/SK无效。 请输入有效的AK/SK后重试。 TRF.0152 您输入的AK/SK无足够权限访问源端桶或者对象。 请确认AK/SK有足够权限后重试。 TRF.0153 您输入的AK/SK无足够权限访问源端桶或者对象。 请确认AK/SK有足够权限后重试。 TRF.0154 您输入的AK/SK无足够权限访问源端桶或者对象。 请确认AK/SK有足够权限后重试。 TRF.0155 源端桶不存在（迁移过程中请勿修改源端桶或者对象的访问权限）。 请确认桶名正确后重试。 TRF.0156 源端对象不存在（迁移过程中请勿修改源端桶或者对象的访问权限）。 请确认桶名或对象名正确后重试。 TRF.0157 源端对象存储服务异常。 请稍后重试，或者联系技术支持。 TRF.0158 任务迁移完成，但目的端对象 数据加密 状态不正确。 请确认目的端区域是否支持KMS加密。 TRF.0159 由于源端对象存储访问频率过高，受源端限制导致任务失败。 请参考返回的error message，或者联系技术支持。 TRF.0160 无法读取归档类型数据。 请解冻数据后进行迁移。 TRF.0201 解冻归档数据失败。 请前往源端手动解冻归档数据后再迁移。 TRF.0202 存在未解冻的归档数据。 请先解冻后再进行迁移。 TRF.0301 选定的对象列表文件属于归档数据无法获取。 请手动解冻后再进行迁移。 父主题： 附录

操作步骤 获取IAM用户Token。 接口相关信息 URI格式：POST /v3/auth/tokens 详情请参见获取IAM用户Token（使用密码）。 请求示例 POST: https://{iam_endpoint}/v3/auth/tokens {endpoint}信息请从地区和终端节点获取。 Body： { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "testname", "domain": { "name": "testname" }, "password": "Password" } } }, "scope": { "project": { "id": "0215ef11e49d4743be23dd97a1561e91" } } } } 响应Header中“X-Subject-Token”的值即为Token： X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX... 调用暂停任务接口暂停迁移任务。 接口相关信息 URI格式：POST /v2/{project_id}/tasks/{task_id}/stop 详情请参见暂停迁移任务。 请求示例 POST: https://{oms_endpoint}/v2/{project_id}/tasks/{task_id}/stop {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: “Token” 响应200表示调用成功。 调用查看任务接口，查看任务状态。 接口相关信息 URI格式： GET /v2/{project_id}/tasks/{task_id} 详情请参见查询指定ID的任务详情。 请求示例 GET: https://{oms_endpoint}/v2/{project_id}/tasks/{task_id} {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: “Token” 响应示例 { "bandwidth_policy" : [], "complete_size" : 2223728, "description" : "", "dst_node" : { "bucket" : "api-test-outline", "region" : "cn-north-7" }, "enable_failed_object_recording" : true, "enable_kms" : false, "enable_restore" : false, "error_reason" : null, "failed_num" : 0, "failed_object_record" : { "result" : null, "list_file_key" : null, "error_code" : null }, "group_id" : "", "id" : 200477729979132, "is_query_over" : true, "left_time" : 0, "migrate_since" : 0, "migrate_speed" : 71477, "name" : "task_name", "progress" : 1.0, "real_size" : 2223728, "skipped_num" : 0, "src_node" : { "bucket" : "a-test-1", "cloud_type" : "HuaweiCloud", "region" : "cn-north-7", "app_id" : "", "object_key" : ["01.png", "list.txt"], "list_file" : null }, "start_time" : 1589267678170, "status" : 3, "successful_num" : 2, "task_type" : "object", "total_num" : 2, "total_size" : 2223728, "total_time" : 31111, "smn_info" : null, "source_cdn" : null } status表示任务执行状态，3代表暂停。 调用删除任务接口删除迁移任务。 接口相关信息 URI格式：DELETE /v2/{project_id}/tasks/{task_id} 详情请参见删除迁移任务。 请求示例 DELETE: https://{oms_endpoint}/v2/{project_id}/tasks/{task_id} {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: “Token” 响应200表示删除成功。

操作步骤 获取IAM用户Token。 接口相关信息 URI格式：POST /v3/auth/tokens 详情请参见获取IAM用户Token（使用密码）。 请求示例 POST: https://{iam_endpoint}/v3/auth/tokens {endpoint}信息请从地区和终端节点获取。 Body： { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "testname", "domain": { "name": "testname" }, "password": "Password" } } }, "scope": { "project": { "id": "0215ef11e49d4743be23dd97a1561e91" } } } } 响应Header中“X-Subject-Token”的值即为Token： X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX... 调用启动任务接口启动迁移任务。 接口相关信息 URI格式：POST /v2/{project_id}/tasks/{task_id}/start 详情请参见启动迁移任务。 请求示例 POST: https://{oms_endpoint}/v2/{project_id}/tasks/{task_id}/start {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: “Token” Body: { "dst_ak" : "destination_ak", "dst_sk" : "destination_sk", "src_ak" : "source_ak", "src_sk" : "source_sk", "migrate_failed_object" : false } 响应200表示调用成功。 调用查看任务接口，查看任务状态。 接口相关信息 URI格式： GET /v2/{project_id}/tasks/{task_id} 详情请参见查询指定ID的任务详情。 请求示例 GET: https://{oms_endpoint}/v2/{project_id}/tasks/{task_id} {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: “Token” 响应示例 { "bandwidth_policy" : [], "complete_size" : 2223728, "description" : "", "dst_node" : { "bucket" : "api-test-outline", "region" : "cn-north-7" }, "enable_failed_object_recording" : true, "enable_kms" : false, "enable_restore" : false, "error_reason" : null, "failed_num" : 0, "failed_object_record" : { "result" : null, "list_file_key" : null, "error_code" : null }, "group_id" : "", "id" : 200477729979132, "is_query_over" : true, "left_time" : 0, "migrate_since" : 0, "migrate_speed" : 71477, "name" : "task_name", "progress" : 1.0, "real_size" : 2223728, "skipped_num" : 0, "src_node" : { "bucket" : "a-test-1", "cloud_type" : "HuaweiCloud", "region" : "cn-north-7", "app_id" : "", "object_key" : ["01.png", "list.txt"], "list_file" : null }, "start_time" : 1589267678170, "status" : 5, "successful_num" : 2, "task_type" : "object", "total_num" : 2, "total_size" : 2223728, "total_time" : 31111, "smn_info" : null, "source_cdn" : null } status表示任务执行状态，2代表正在执行，5表示执行成功。

修订记录 发布时间 修订记录 2023-11-15 第二十三次正式发布。 API V2新增桶操作、云服务、区域 2023-09-20 第二十二次正式发布。 更新终端节点。 2023-04-14 第二十一次正式发布。 更新创建迁移任务组。 2022-09-16 第二十次正式发布。 新增迁移任务组管理。 2022-07-28 第十九次正式发布。 更新终端节点。 2022-06-23 第十八次正式发布。 更新创建同步事件。 2021-05-28 第十七次正式发布。 更新错误码。 2021-02-25 第十六次正式发布。 优化错误码内容。 优化API V2（推荐）内容。 2020-12-28 第十五次正式发布。 优化API V2（推荐）、错误码内容。 2020-09-15 第十四次正式发布。 新增API V2（推荐）内容。 2019-11-30 第十三次正式发布。 在创建任务中，优化object_key、list_file与task_type对应关系说明。 在历史错误码中，新增错误码：S3M.0088。 2019-10-30 第十二次正式发布。 在终端节点中，更新 OMS 的Endpoint。 2019-08-31 第十一次正式发布。 在创建任务的请求参数中，增加参数bandwidth_policy。 增加修改流量控制策略一节。 在查询某个租户的所有任务的响应参数中，增加参数bandwidth_policy。 在查询指定ID的任务的响应参数中，增加参数bandwidth_policy。 在历史错误码中，增加错误码TRF.0013、TRF.0014、TRF.0301、S3M.0083~S3M.0087。 2019-04-29 第十次正式发布。 在创建任务的请求参数中，增加参数auto_restore。 在查询某个租户的所有任务的响应参数中，增加参数auto_restore。 在查询指定ID的任务的响应参数中，增加参数auto_restore。 在历史错误码中，增加错误码S3M.0082、TRF.0063、TRF.0064。 2019-04-17 第九次正式发布。 在认证鉴权中，更新Token认证的内容。 在终端节点中，更新OMS的Endpoint。 在API示例中，参数thread_num更新取值。 在创建任务中，参数region、topicUrn增加说明。 在创建任务中，源端cloud_type参数增加取值“HuaweiCloud”。 在创建任务中，dst_node数据结构的参数object_key修正为必选。 在创建任务中，参数authentication_type、authentication_key更新描述。 在创建任务中，参数enable_failed_object_recording更新描述。 在查询某个租户的所有任务中，参数authentication_type更新描述。 在历史错误码中，增加错误码S3M.0168、S3M.0169、TRF.0160。 2019-01-22 第八次正式发布。 在创建任务中，参数path更新描述。 2018-12-21 第七次正式发布。 在创建任务中，参数obs_bucket增加说明。 在创建任务中，参数protocol增加http取值。 在创建任务中，参数migrate_since更新描述。 在历史错误码中，错误码S3M.0081更新错误信息。 2018-09-30 第六次正式发布。 优化文档整体架构。 新增查询API版本接口。 源端cloud_type参数增加取值KingsoftCloud。 task_type参数增加取值prefix。 object_key参数增加废弃说明。 在API说明章节增加失败对象重传参数。 增加错误码：S3M.0079、S3M.0080、S3M.0081、S3M.0162、S3M.0163、S3M.0167、S3M.0256、TRF.0012、TRF.0159。 2018-08-09 第五次正式发布。 新增任务创建接口传入参数migrate_since, source_cdn, task_type。 新增任务查询接口响应参数source_cdn, task_type。 2018-06-06 第四次正式发布。 增加错误状态码406。 将object_key数据结构的参数名称“Keys”修改为“keys”。 2018-03-02 第三次正式发布。 增加错误码TRF.0158。 增加查询配额的接口。 2018-01-15 第二次正式发布。 修改源端cloud_type参数说明。 2017-09-15 第一次正式发布。

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中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/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

状态码 状态码如表1所示。 表1 状态码 状态码 描述 说明 200 OK 请求被成功处理。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 429 Too Many Requests 请求频繁异常 请稍后重试。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 父主题： 附录

示例 请求示例 GET /v1/{project_id}/objectstorage/task/{task_id} 响应示例 { "id": 1, "name": "bucket3-bucket3-20161027211637786_544", "src_node": { "region": "us-east-1", "bucket": "bucket3", "object_key": "/", "cloud_type": "xxx" }, "dst_node": { "region": "xxx", "bucket": "bucket3", "object_key": ["log/object1", "log/object2"], "cloud_type": "HEC" }, "thread_num": 50, "status": 5, "progress": 1, "total_num": 2000, "success_num": 200, "fail_num": 0, "migrate_speed": 7213154, "enableKMS": true, "description": "ZXCZCZXCDVXVC", "error_reason": "", "total_size": 2000000000, "complete_size": 2000000000, "start_time": 1477574224062, "left_time": 0, "total_time": 88124, "smnInfo": { "notifyResult": false, "notifyErrorMessage": "S3M.0156", "topicName": "Test" }, "migrate_since": 123456789, "source_cdn": { "protocol": "https", "domain": "xxx.xxx.xxx", "authentication_type": "NONE" }, "bandwidth_policy": [ { "start": "00:00", "end": "23:59", "max_bandwidth": 50000000 } ] }

响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数 类型 描述 id long 任务ID。 name String 任务名称。 src_node JSONObject 源端节点信息，参见表3。 dst_node JSONObject 目的端节点信息，参见表5。 thread_num int 迁移线程数。 status int 任务状态。 0：初始化 1：等待调度 2：正在执行 3：停止 4：失败 5：成功 progress double 任务进度，例如：0.522代表任务进度为52.2%，1代表任务进度为100%。 migrate_speed long 任务迁移速度（Byte/s）。 enableKMS boolean 是否使用KMS加密。 description String 任务描述，没有设置时为空字符串。 error_reason JSONObject 任务失败原因，参见表8。 total_size long 任务迁移总大小。 complete_size long 任务迁移完成大小。 start_time long 任务启动时间。 left_time long 任务剩余时间。 total_time long 任务总时间。 success_num long 迁移成功对象数量。 fail_num long 迁移失败对象数量。 total_num long 迁移对象总数量。 smnInfo JSONObject SMN 消息，参见表6。 说明： 用户可以选择是否发送SMN信息，在迁移任务已经结束的情况下才会有该字段。 migrate_since long 迁移指定时间，表示仅迁移在指定时间之后修改的源端待迁移对象。默认为0，表示不设置迁移指定时间。 task_type String 任务类型，为空则默认设置为object。 list：对象列表迁移 object：文件/文件夹迁移 prefix：对象前缀迁移 source_cdn JSONObject 指定是否启用CDN迁移支持，参见表7。若包含此字段则为支持，否则为不支持。启用CDN迁移支持后，迁移时将从CDN域名获取源端对象。 auto_restore Boolean 是否自动解冻归档数据。开启后，如果遇到归档类型数据，会自动解冻再进行迁移。 enable_failed_object_recording Boolean 是否记录失败对象。开启后，如果有迁移失败对象，会在目的端存储失败对象信息。 failed_object_record String 数据格式为JSON格式，参见表9。 bandwidth_policy JSONArray 流量控制策略，参见表10。 表3 src_node数据结构说明 参数 类型 描述 region String 源端桶所处的区域。 list_file JSONObject 数据格式为JSON格式，参见表4。 object_key JSONArray 源端桶选择的对象名称。每个元素均为对象的绝对路径。 bucket String 源端桶的名称。 cloud_type String 源端云服务商。 表4 list_file数据结构 参数 参数类型 描述 obs_bucket String 存放对象列表文件的OBS桶名。 list_file_key String 对象列表文件对象名。 表5 dst_node数据结构说明 参数 类型 描述 region String 目的端桶所处的区域。 object_key String 目的端桶选择的对象名称。 bucket String 目的端桶的名称。 cloud_type String 目的端云服务商。 表6 smnInfo数据结构说明 参数 类型 描述 notifyResult Boolean 记录迁移任务执行完毕后SMN消息是否发送成功。 notifyErrorMessage String 记录SMN消息发送失败原因的错误码（迁移任务成功时为空）。 topicName String SMN Topic的名称（SMN消息发送成功时为空）。 表7 source_cdn数据结构 参数 类型 描述 protocol String 协议类型：https或http。 domain String 从指定域名获取对象。 authentication_type String 鉴权方式。 无需鉴权：NONE Qiniu：QINIU_PRIVATE_AUTHENTICATION 表8 error_reason数据结构说明 参数 类型 描述 error_code String 迁移失败的错误码。 error_msg String 迁移失败的原因。 表9 failed_object_record结构说明 参数 参数类型 描述 result Boolean 是否支持失败对象重传。 list_file_key String 失败对象列表文件路径。 errorCode String 不支持失败重传的错误码。 表10 bandwidth_policy数据结构 参数 参数类型 描述 start String 流量控制开始时间（包含），格式为“hh:mm”。例如“10:03”表示10时03分。 end String 流量控制结束时间（包含），格式和start参数相同。 max_bandwidth int 时段内允许的最大流量带宽，单位Byte/s。

URI GET /v1/{project_id}/objectstorage/task?totalcount={true}&state={state} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 totalcount 是 返回任务数标志，true表示将返回满足条件的任务数量。 state 否 任务状态。 0：初始化 1：等待调度 2：正在执行 3：停止 4：失败 5：成功

示例 请求示例 GET /v1/{project_id}/objectstorage/task?start=0&limit=10&state=0 响应示例 { "id": 1, "name": "bucket3-bucket3-20161027211637786_544", "src_node": { "region": "us-east-1", "bucket": "bucket3", "object_key": ["log/object1", "log/object2"] }, "dst_node": { "region": "xxx", "bucket": "bucket3", "object_key": "/" }, "thread_num": 50, "status": 5, "progress": 1, "total_num": 2000, "success_num": 200, "fail_num": 0, "migrate_speed": 7213154, "enableKMS": true, "description": "ZXCZCZXCDVXVC", "error_reason": "", "total_size": 2000000000, "complete_size": 2000000000, "start_time": 1477574224062, "left_time": 0, "total_time": 88124, "smnInfo": { "notifyResult": false, "notifyErrorMessage": "S3M.0156", "topicName": "Test" }, "enable_failed_object_recording": true, "failed_object_record": "{" result ": true, " list_file_key ": " oms / failed_object_lists / 180840792025063 / failed - objects - list.txt "}" }, { "id": 2, "name": "bucket3-bucket3-20161027211637786_545", "src_node": { "region": "us-east-1", "bucket": "bucket3", "object_key": ["log/object1", "log/object2"], "cloud_type": "xxx" }, "dst_node": { "region": "xxx", "bucket": "bucket3", "object_key": "/", "cloud_type": "HEC" }, "thread_num": 50, "status": 5, "progress": 1, "total_num": 2000, "success_num": 200, "fail_num": 0, "migrate_speed": 7213154, "enableKMS": true, "description": "ZXCZCZXCDVXVC", "error_reason": "", "total_size": 2000000000, "complete_size": 2000000000, "start_time": 1477574224062, "left_time": 0, "total_time": 88124, "smnInfo": { "notifyResult": false, "notifyErrorMessage": "S3M.0156", "topicName": "Test" }, "migrate_since": 123456789, "source_cdn": { "protocol": "https", "domain": "xxx.xxx.xxx", "authentication_type": "NONE" }, "bandwidth_policy": [ { "start": "00:00", "end": "23:59", "max_bandwidth": 50000000 } ] }

响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 id long 任务ID。 name String 任务名称。 src_node JSONObject 源端节点信息，参见表3。 dst_node JSONObject 目的端节点信息，参见表5。 thread_num int 迁移线程数。 status int 任务状态。 0：初始化 1：等待调度 2：正在执行 3：停止 4：失败 5：成功 progress double 任务进度，例如：0.522代表任务进度为52.2%，1代表任务进度为100%。 migrate_speed long 任务迁移速度（Byte/s）。 enableKMS boolean 是否使用KMS加密。 description String 任务描述，没有设置时为空字符串。 error_reason JSONObject 任务失败原因，参见表8。非失败状态时该字段为空字符串。 total_size long 任务迁移总大小。 complete_size long 任务迁移完成大小。 start_time long 任务启动时间。 left_time long 任务剩余时间。 total_time long 任务总时间。 success_num long 迁移成功对象数量。 fail_num long 迁移失败对象数量。 total_num long 迁移对象总数量。 smnInfo JSONObject SMN消息，参见表6。 说明： 用户可以选择是否发送SMN信息，在迁移任务已经结束的情况下才会有该字段。 migrate_since long 迁移指定时间，表示仅迁移在指定时间之后修改的源端待迁移对象。默认为0，表示不设置迁移指定时间。 task_type String 任务类型，为空默认设置为object。 list：对象列表迁移 object：文件/文件夹迁移 prefix：对象前缀迁移 source_cdn JSONObject 指定是否启用CDN迁移支持，参见表7。启用CDN迁移支持后，迁移时将从CDN域名获取源端对象。若包含此字段则为支持，否则为不支持。 auto_restore Boolean 是否自动解冻归档数据。开启后，如果遇到归档类型数据，会自动解冻再进行迁移。 enable_failed_object_recording Boolean 是否记录失败对象。开启后，如果有迁移失败对象，会在目的端存储失败对象信息。 failed_object_record String 数据格式为JSON格式，参见表9。 bandwidth_policy JSONArray 流量控制策略，参见表10。 表3 src_node数据结构说明 参数 参数类型 描述 region String 源端桶所处的区域。 list_file JSONObject 数据格式为JSON格式，参见表4。 object_key JSONArray 源桶选择的对象名称，JSONArray格式。每个元素均为对象的绝对路径。 bucket String 源端桶的名称。 cloud_type String 源端云服务商。 表4 list_file数据结构 参数 参数类型 描述 obs_bucket String 存放对象列表文件的OBS桶名。 list_file_key String 对象列表文件对象名。 表5 dst_node数据结构说明 参数 参数类型 描述 region String 目的端桶所处的区域。 object_key String 目的端桶选择的对象名称。 bucket String 目的端桶的名称。 cloud_type String 目的端云服务商。 表6 smnInfo数据结构说明 参数 参数类型 描述 notifyResult Boolean 记录迁移任务执行完毕后SMN消息是否发送成功。 notifyErrorMessage String 记录SMN消息发送失败原因的错误码（迁移任务成功时为空）。 topicName String SMN Topic的名称（SMN消息发送成功时为空）。 表7 source_cdn数据结构 参数 参数类型 描述 protocol String 协议类型：https或http。 domain String 从指定域名获取对象。 authentication_type String 鉴权方式。 无需鉴权：NONE Qiniu： QINIU_PRIVATE_AUTHENTICATION Aliyun： ALIYUN_OSS_A、ALIYUN_OSS_B、ALIYUN_OSS_C KingsoftCloud：KSYUN_PRIVATE_AUTHENTICATION 表8 error_reason数据结构说明 参数 参数类型 描述 error_code String 迁移失败的错误码。 error_msg String 迁移失败的原因。 表9 failed_object_record结构说明 参数 参数类型 描述 result Boolean 是否支持失败对象重传。 list_file_key String 失败对象列表文件路径。 errorCode String 不支持失败重传的错误码。 表10 bandwidth_policy数据结构 参数 参数类型 描述 start String 流量控制开始时间（包含），格式为“hh:mm”。例如“10:03”表示10时03分。 end String 流量控制结束时间（包含），格式和start参数相同。 max_bandwidth int 时段内允许的最大流量带宽，单位Byte/s。

URI GET /v1/{project_id}/objectstorage/task?start={start}&limit={limit}&state={state} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 start 是 起始的任务序号。 limit 是 返回任务个数的最大值，最大不超过100，否则查询失败。 state 否 任务状态。 0：初始化 1：等待调度 2：正在执行 3：停止 4：失败 5：成功

示例 请求示例 PUT /v1/{project_id}/objectstorage/task/{task_id} { "operation": "change_bandwidthpolicy", "bandwidth_policy": [ { "start": "00:00", "end": "23:59", "max_bandwidth": 50000000 } ] } 响应示例 无。

请求消息 请求参数 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 operation 是 String 操作类型，本接口为start。 source_ak 是 String 源端节点AK（最大长度100个字符）。 source_sk 是 String 源端节点SK（最大长度100个字符）。 target_ak 是 String 目的端节点AK（最大长度100个字符）。 target_sk 是 String 目的端节点SK（最大长度100个字符）。 source_cdn_authentication_key 否 String CDN鉴权秘钥。 migration_failed_object 否 Boolean 迁移类型，标识是否为全量迁移。 值为true时表示重传失败对象。 值为空或者为false时表示全量迁移。