华为云用户手册

Windows系统操作步骤 登录已安装客户端的Windows服务器。 打开命令行窗口，进入“安装路径\bin”目录。 执行agent_stop.bat命令，停止客户端运行。 将新的证书和私钥文件放到指定目录。 新的证书必须放到“安装路径\bin\nginx\conf”目录下。 执行agentcli.exe chgkey命令。 显示如下回显信息： Enter password of admin: admin”为安装客户端时设置的用户名。 输入新的证书名称，按“Enter”。 如果私钥文件和证书是同一个文件，证书和私钥文件名称都为该文件名称。 显示如下回显信息： Change certificate key file name: 输入新的私钥文件名称，按“Enter”。 显示如下回显信息： Enter new password: Enter the new password again: 输入两次私钥文件的保护密码，替换证书成功。 执行agent_start.bat命令，启动客户端。

支持审计的关键操作列表 表1 云审计 服务支持的CBR操作列表 操作名称 资源类型 事件名称 创建策略 policy createPolicy 更新策略 policy updatePolicy 删除策略 policy deletePolicy 设置存储库策略 vault associatePolicy 解除存储库策略 vault dissociatePolicy 创建存储库 vault createVault 修改存储库 vault updateVault 删除存储库 vault deleteVault 移除资源 vault removeResources 添加资源 vault addResources 执行复制 vault replicateVaultBackup 执行备份 vault createVaultBackup 创建备份 backup createBackup 删除备份 backup deleteBackup 同步备份 backup syncBackup 恢复备份 backup restoreBackup 复制备份 backup replicateBackup

操作说明 当前仅支持x86计算类型的服务器，暂不支持鲲鹏计算类型的服务器。 安装客户端时，系统会以“rdadmin”用户运行安装程序。请定期修改Agent的操作系统“rdadmin”用户的登录密码，并禁止“rdadmin”用户远程登录，以提升系统运维安全性。详情请参见修改rdadmin账号密码。 支持安装客户端的操作系统如表1所示。 表1 支持安装客户端的操作系统列表 数据库名称 操作系统类型 版本范围 SQLServer 2008/2012/2019 Windows Windows Server 2008, 2008 R2, 2012, 2012 R2, 2019 for x86_64 SQLServer 2014/2016/EE Windows Windows Server 2014, 2014 R2, 2016 Datacenter for x86_64 MySQL 5.5/5.6/5.7 Red Hat Red Hat Enterprise Linux 6, 7 for x86_64 SUSE SUSE Linux Enterprise Server 11, 12, 15 SP1, 15 SP2 for x86_64 CentOS CentOS 6, 7 for x86_64 Euler Euler OS 2.2, 2.3 for x86_64 HANA 1.0/2.0 SUSE SUSE Linux Enterprise Server 12 for x86_64 对于Windows 操作系统，需要Volume Shadow Copy 服务正常运行，才能备份成功。 支持的sha256值如表2所示。 表2 sha256值 包名 sha256值 Cloud Server Backup Agent-CentOS6-x86_64.tar.gz f0c59ccb4443bcb6e874bf6e3c574914f9f8b27f3f7379e2d81956a9972802f3 Cloud Server Backup Agent-CentOS7-x86_64.tar.gz 2d3028cb794e1699bae9f65746a60ae99be17d5c4c5e7ebe6b45ff261db9c3c7 Cloud Server Backup Agent-EulerOS2-x86_64.tar.gz 4fb4cf9cb6f5b0e6c13d8ad8bf928754cb95332ee645a97fd0bb3fcbeb53d003 Cloud Server Backup Agent-RedHat6-x86_64.tar.gz 6ae3838fb5644f0f47282c211fe20c6b57a7c5c1d683cd5a1f55860d259b2054 Cloud Server Backup Agent-RedHat7-x86_64.tar.gz 40fa68a808d9da04672678b2773e3345ea6c9dee3c17d598acb66a023cc5cacc Cloud Server Backup Agent-SuSE11-x86_64.tar.gz 346cc9f1fc0a41a817abb2db61e657a4d615449e13bc46f1c1cfbadc0b281f47 Cloud Server Backup Agent-SuSE12-x86_64.tar.gz 625279b9c9d17ddcc4210b78242efebacdad73f808b86754659d243ece85a400 Cloud Server Backup Agent-WIN64.zip b7b2067ac89f1fec635d82e3fe2ea794ce6482f9880838f34924b383be44ac4e 客户端安装时，系统会打开弹性云服务器的59526-59528端口的防火墙其中之一。当59526端口被占用时，则会打开59527端口的防火墙，以此类推。

迁移规则说明 进行一键迁移时，系统会根据您的历史资源情况为您自动创建存储库。 表1 迁移规则说明 迁移前 迁移后 服务器或磁盘绑定在备份策略中 已产生过备份，无论策略是否开启，则迁移时系统会创建一个与策略名称（最长为64位）相同的存储库，创建成功后策略会绑定存储库。 未产生过备份，仅在策略开启的情况下会创建存储库，创建成功后策略会绑定存储库命名规则同上。 服务器或磁盘绑定在备份或复制策略中 未产生过备份，且策略未开启时，仅对策略进行迁移。 备份或复制策略未绑定服务器或磁盘 对策略进行迁移。 开启数据库备份 创建存储库时会创建和该策略名称一致的数据库备份存储库。 复制产生的备份 存放在一个命名为“default”的复制存储库。 使用备份创建过镜像且已为镜像添加标签 可能会导致备份迁移失败。您需要前往 镜像服务 ，删除该镜像的标签后再进行迁移。迁移完成后再重新添加标签即可。 手动备份等其他备份单独存放在一个命名为“default”的服务器备份存储库。不同资源会自动创建对应的存储库。如云硬盘备份迁移时，会自动创建云硬盘备份存储库。 迁移备份时，只要在上海一、上海二、北京一、北京四、广州、新加坡、香港以及曼谷其中一个区域迁移备份，则列举的区域的所有备份在迁移时会一同迁移。其他区域的备份不会一起迁移，需要单独前往该区域进行迁移。 迁移成功后，在新服务云备份中创建的备份也会出现在原云硬盘备份服务中，但不会重复计费，属于正常现象。 如果您希望删除旧版云硬盘备份服务中的备份，需要在新版服务中找到对应的备份进行删除，则旧版服务的备份也会同时删除，无法在旧版服务中删除。 根据以上规则，系统在创建存储库时，每个存储库预设容量为：备份数据所占容量*1.2。 例如：某用户拥有容量分别为100GB和50GB的云服务器，实际存储数据的容量分别为20GB和10GB，使用云服务器备份服务分别手动创建过一个普通整机备份。进行迁移时，默认创建的存储库将为备份数据所占容量*1.2。本例中备份数据所占容量*1.2为36GB。此时系统会自动创建一个大小为36GB的存储库。

约束与限制 系统默认创建的存储库为按需付费模式，如果您希望使用包年包月付费模式，请参考按需转包周期完成存储库按需转包周期。 迁移后，云硬盘备份和云服务器备份将无法使用，新服务云备份将使用新的计费模式进行计费，具体请参考云备份计费模式。 一键迁移时，无法使用已经购买的存储库，系统会自动迁移资源至系统创建的存储库中。 一个账号下的备份资源只需要迁移一次即可。 迁移完成后，云硬盘备份和云服务器备份会自动存放在云备份存储库中，无需再手动进行操作。

常见问题 为什么新版服务中的备份也会出现在旧版服务？ 答：如果您已完成旧版服务迁移备份至新版服务，在新版的云备份服务创建备份后，会同时在旧版的云硬盘备份服务中产生相同的备份记录。这是由于底层机制，旧版的云硬盘备份会展示包括云备份、云服务器备份以及云硬盘备份产生的所有备份，但这些备份不会重复计费，仅作为界面展示。 我需要删除旧版的备份如何操作？ 答：如果您希望删除旧版云硬盘备份服务中的备份，需要在新版服务中找到对应的备份进行删除，则旧版服务的备份也会同时删除，无法在旧版服务中删除。 云备份CBR和云服务器备份 CS BS、云硬盘备份VBS有什么区别？ 答： 云备份服务CBR 融合云服务器备份服务CSBS和云硬盘备份服务VBS，功能相较两个服务更强大，在支持云服务器备份服务和云硬盘备份服务原有功能上，更支持SFS Turbo备份和混合云备份等新功能。使用模式和计费模式与两个服务也有所不同。 绑定资源时提示“已挂载至原备份服务中”，无法绑定至存储库怎么办？ 答：需要在控制台上服务列表中选择“云硬盘备份”服务或者“云服务器备份”，前往该服务控制台上“策略”页签确认，是否有资源挂载至策略中。如果存在，请在“策略”页签下解绑资源后，再前往云备份控制台绑定资源至存储库。

Linux系统操作步骤 使用服务器密码登录Linux系统服务器。 执行TMOUT=0命令，防止“PuTTY”超时退出。 执行该命令后，当前系统在无操作时会保持运行状态，存在安全风险，为了确保系统安全，请在完成相应操作后，执行exit退出当前系统。 执行su - rdadmin命令，切换为“rdadmin”用户。 执行/home/rdadmin/Agent/bin/agentcli chgsnmp命令，输入客户端登录账号的密码，按“Enter”。 客户端安装路径固定为“/home/rdadmin/Agent”。 Please choose operation: 1: Change authentication password 2: Change private password 3: Change authentication protocol 4: Change private protocol 5: Change security name 6: Change security Level 7: Change security model 8: Change context engine ID 9: Change context name Other: Quit Please choose: 选择需要修改的授权认证密码或 数据加密 密码对应序号，按“Enter”。 输入旧密码，按“Enter”。 输入新密码，按“Enter”。 再次输入新密码，按“Enter”。完成修改密码。

Windows系统操作步骤 登录已安装客户端的云服务器。 打开命令行窗口，进入“安装路径\bin”目录。 输入agentcli.exe chgsnmp命令，输入客户端登录账号的密码，按“Enter”。 Please choose operation: 1: Change authentication password 2: Change private password 3: Change authentication protocol 4: Change private protocol 5: Change security name 6: Change security Level 7: Change security model 8: Change context engine ID 9: Change context name Other: Quit Please choose: “admin”为安装客户端时设置的用户名。 选择需要修改的授权认证密码或数据加密密码对应序号，按“Enter”。 输入旧密码，按“Enter”。 输入新密码，按“Enter”。 再次输入新密码，“Enter”。完成修改密码。

约束与限制 云硬盘备份存储库不支持复制至其他区域。 支持复制到多个目标区域的存储库中，复制成功后会占用相应的存储容量。 存储库中包含同时满足以下条件的云服务器备份才能执行创建复制操作： 备份由弹性云服务器产生。 备份数据包含系统盘。 备份状态为“可用”。 存储库中包含同时满足以下条件的SFS Turbo备份才能执行创建复制操作： 备份由sfs turbo文件系统产生。 备份状态为“可用”。 仅支持对源区域生成的同类型备份存储库执行复制操作，不支持对复制操作产生的复制存储库再次执行复制操作，从其他区域复制而来的备份仅可用于创建镜像或文件系统。 一个备份存储库可以分别复制到不同的目标区域。对备份存储库手动创建复制或通过策略复制，每个目标区域仅能复制一次，即使将目标备份删除后也不允许再次复制。 仅支持复制到同类型的复制存储库中。例如，需要将云服务器在区域一产生的备份复制至区域二，则需要在区域二购买保护类型为“复制”的云服务器存储库。 仅支持向具备复制能力的目标区域复制备份存储库，具体支持复制到的目标区域对应情况详见表1。 表1 跨区域复制支持区域 源区域 支持复制到的目标区域 说明 乌兰察布一 北京四、上海一、广州 - 深圳 北京四 - 贵阳一 北京四、上海一 - 北京一 北京四、上海二、上海一、广州 - 北京四 乌兰察布一、深圳、贵阳一、北京一、上海二、上海一、广州 - 上海二 北京一、北京四、上海一、广州 - 上海一 乌兰察布一、贵阳一、北京一、北京四、上海二、广州 - 广州 乌兰察布一、北京一、北京四、上海二、上海一 - 香港、曼谷、新加坡 香港、曼谷、新加坡 几个区域间支持互相复制

操作场景 云服务器备份存储库和SFS Turbo备份存储库支持将整个存储库的备份复制到同一账号下另一区域的复制存储库中。云服务器备份后续可在另一个区域使用复制的备份数据创建镜像，并发放新的云服务器。SFS Turbo备份后续可在另一个区域使用复制的备份创建新的文件系统。通过复制功能，您可以快速跨区域部署业务。 复制存储库主要有以下两种复制方式： 选中某一个备份存储库，手动执行一次复制。 配置存储库的复制策略，周期性的对未向目标区域进行过复制或复制失败的备份执行复制操作。

文件备份操作流程 文件备份操作流程如图1所示。 图1 文件备份操作流程 创建混合云备份存储库： 创建用于存放文件备份的存储库。在安装文件备份客户端前需要先完成存储库的创建。 下载并安装客户端： 进行文件备份前需要先在目标服务器上下载和安装客户端。安装完成后，云备份系统会自动发现已安装客户端的主机，显示在文件备份客户端列表中。 配置存储库： 将目标客户端配置至对应的备份存储库，文件目录产生的备份将存放在存储库中。 新增备份文件： 添加目标客户端中需要备份的文件目录路径。 创建文件备份： 可为资源创建手动备份和自动备份，备份将存放在存储库中。。 使用文件备份恢复数据： 可以使用云上备份将数据恢复至原服务器或新服务器均可。相关操作请参见使用文件备份恢复数据。 父主题： 文件备份

操作步骤 单击控制台页面右上方的“企业”。进入企业管理的“总览”页面。 在企业管理页面，选择“企业项目管理”。 选择待迁出存储库的企业项目。单击操作列“ 查看资源 ”。系统进入企业项目详情页面，在“资源”页签下可查看该企业项目内资源信息。 勾选需要迁出的资源后单击“迁出”，在弹出的对话中选择“迁出方式”，选择“单资源迁出”。 选择迁入企业项目，单击“确定”。 存储库迁出完成，在迁入企业项目的资源列表中即可查看已迁出的资源。

组织策略概述 云备份服务支持基于组织的统一策略管理能力，组织管理员或CBR服务的委托管理员可以通过创建组织策略，为组织内成员账号统一设置组织策略，成员账号可以使用创建的组织策略。 管理账号在创建组织策略的时候，会默认启用CBR为可信服务。开启CBR为可信服务后，CBR可以获取组织中的组织单元及成员账号信息，基于此信息提供组织级的管理能力，统一为整个组织提供云备份服务，记录组织中所有账号的操作。 组织策略分为组织备份策略和组织复制策略。 组织备份策略：当企业需要为组织内成员账号统一设置备份策略时，可以通过组织的管理账号创建组织备份策略来实现该功能，成员账号可以使用创建的组织备份策略。 组织复制策略：当企业需要为组织内成员账号统一设置复制策略时，可以通过组织的管理账号创建组织复制策略来实现该功能，成员账号可以使用创建的组织复制策略。 父主题： 管理组织策略

配置强制备份策略 通过配置强制备份策略可以达到让 IAM 用户强制执行数据备份的目的，能够最大限度保障用户数据的安全性和正确性，确保业务安全。 强制备份策略配置之后，可以对IAM用户做以下限制。 在创建备份策略时，备份策略必须是开启状态。 在修改备份策略时，禁止关闭备份策略。 在创建存储库时，必须绑定备份策略。 为了确保备份强制性，建议三种策略都配置上。 目前华为云支持以下两种方式创建自定义策略： 可视化视图创建自定义策略：无需了解策略语法，按可视化视图导航栏选择云服务、操作、资源、条件等策略内容，可自动生成策略。 JSON视图创建自定义策略：可以在选择策略模板后，根据具体需求编辑策略内容；也可以直接在编辑框内编写JSON格式的策略内容。 具体创建步骤请参见：创建自定义策略。 在创建备份策略时，备份策略必须是开启状态。 { "Version": "5.0", "Statement": [ { "Effect": "Deny", "Action": ["cbr:policies:create"], "Condition": { "Bool": { "cbr:EnabledPolicy": "false" } } } ] } 在修改备份策略时，禁止关闭备份策略。 { "Version": "5.0", "Statement": [ { "Effect": "Deny", "Action": ["cbr:policies:update"], "Condition": { "Bool": { "cbr:EnabledPolicy": "false" } } } ] } 在创建存储库时，必须绑定备份策略。 { "Version": "5.0", "Statement": [ { "Effect": "Deny", "Action": [ "cbr:vaults:create" ], "Condition": { "Null": { "cbr:PolicyId": [ "true" ] } } } ] } 父主题： 管理权限

云备份支持的备份功能 备份支持如下操作。 表3 功能 说明 查看备份 在备份任务正在执行或完成后，可以通过各种筛选条件在备份列表查看备份详情。 修改备份名称 对已创建的备份，支持修改备份名称便于识别。可以修改手动备份和自动备份的名称。 共享备份 在对服务器和磁盘数据进行备份后，可将备份共享给其他账户下的项目使用。共享的备份可用于创建磁盘或服务器等操作。 删除备份 用户可以根据实际情况删除无用的备份以节省空间和成本。 跨区域复制备份 云服务器备份存储库、SFS Turbo备份存储库和混合 云存储 备份存储库的跨区域复制能力支持将已生成的备份复制到另一个区域。

备份方式 云备份提供两种配置方式，一次性备份和周期性备份。一次性备份是指用户手动创建的一次性备份任务。周期性备份是指用户通过创建备份策略并绑定存储库的方式创建的周期性备份任务。 云备份的两种配置方式对比如表2，可根据实际情况选择适合的配置方式。 表2 两种配置方式对比 对比项 一次性备份 周期性备份 备份策略 不需要 需要 备份次数 手动执行一次性备份 根据备份策略进行周期性备份 备份名称 支持自定义，默认为“manualbk_xxxx” 系统自动生成，默认为“autobk_xxxx” 备份方式 默认首次全量备份，后续增量备份 默认首次全量备份，后续增量备份 建议使用场景 资源进行操作系统补丁安装、升级，应用升级等操作之前，以便安装或者升级失败之后，能够快速恢复到变更之前的状态。 资源的日常备份保护，以便发生不可预见的故障而造成数据丢失时，能够使用邻近的备份进行恢复。 另外，用户也可以根据业务情况将两种方式混合使用。例如，根据数据的重要程度不同，可以将所有的资源绑定至同一个存储库，并将该存储库绑定到一个备份策略中进行日常备份保护。其中个别保存有非常重要的数据的资源，根据需要不定期地执行一次性备份，保证数据的安全性。操作流程如下图1所示。 您可以根据需要，为资源创建多个备份。单个资源创建的备份个数没有限制。 图1 两种配置方式混合使用

什么是备份 备份即一个备份对象执行一次备份任务产生的备份数据，包括备份对象恢复所需要的全部数据。备份可以通过一次性备份和周期性备份两种方式产生。 云备份提供两种配置方式，一次性备份和周期性备份。一次性备份是指用户手动创建的一次性备份任务。周期性备份是指用户通过创建备份策略并绑定服务器的方式创建的周期性备份任务。 一次性备份的备份名称支持用户自定义，也可以采用系统自动生成的名称。一次性备份产生的备份名称为“manualbk_xxxx”。 周期性备份的备份名称由系统自动生成。周期性备份产生的备份名称为“autobk_xxxx”。

云备份类型 云备份产生的备份可以分为几种类型： 云硬盘备份：云硬盘备份提供对云硬盘的基于快照技术的数据保护。 云服务器备份：云服务器备份提供对弹性云服务器和裸金属服务器的基于多云硬盘一致性快照技术的数据保护。同时，未部署数据库等应用的服务器产生的备份为服务器备份，部署数据库等应用的服务器产生的备份为数据库服务器备份。 SFS Turbo备份：SFS Turbo备份提供对SFS Turbo文件系统的数据保护。 混合云备份：混合云备份提供对线下VMware服务器备份的数据保护。 文件备份：文件备份提供对云上服务器或用户数据中心虚拟机中的单个或多个文件的数据保护，无需再以整机或整盘的形式进行备份。 云桌面 备份：云桌面备份提供对云桌面的数据保护。 表1 几种备份差异 对比维度 云服务器备份 云硬盘备份 SFS Turbo备份 云桌面备份 混合云备份 文件备份 备份/恢复对象 服务器中的全部云硬盘（系统盘和数据盘）或部分云硬盘、部署数据库等应用的云服务器（数据库服务器备份） 指定的单个或多个磁盘（系统盘或数据盘） 高性能弹性文件服务中的SFS Turbo文件系统 云桌面整个系统，包括所有的磁盘 可以同步云下服务器备份数据，可以将云下数据恢复至云端服务器 云上服务器或用户数据中心虚拟机中的单个或多个文件 推荐场景 需要对整个云服务器进行保护 系统盘没有个人数据，因而只需要对部分的数据盘进行备份 需要对文件系统的数据进行保护 需要对云桌面进行保护 需要在云上对云下服务器的备份数据进行管理，在云上使用云下数据恢复服务器等 需要将单个或多个文件备份上云，并且可以使用备份快速恢复数据 优势 备份的同一个服务器下的所有磁盘数据具有一致性，即同时对所有云硬盘进行备份，不存在因备份创建时间差带来的数据不一致问题 保证数据安全的同时降低备份成本 备份数据与文件系统分开存放，可以使用备份创建新的文件系统 备份数据与云桌面分开存放，可以使用备份恢复云桌面的数据 云下数据可以用于在云上搭建新的业务，将数据在云上备份 无需再以整机或整盘的形式进行备份，降低备份成本

备份机制 云备份的云内备份均为块级备份，支持文件级备份。首次备份为全量备份，备份资源已使用空间。如某磁盘大小为100GB，已使用空间为40GB，则备份的是40GB的已使用空间。后续备份均为增量备份，备份上次备份后变化的数据，缩短备份时长、节约备份空间。删除备份时，仅删除不被其他备份依赖的数据块，不影响使用其他备份进行恢复。无论是全量还是增量备份，都可以快速、方便地将数据恢复至备份所在时刻的状态。 云备份会在备份过程中自动创建快照并且为每个磁盘保留最新的快照。如果该磁盘已备份，再次备份后会自动将旧快照删除，保留最新的快照。 云备份通过与 对象存储服务 的结合，将数据备份到对象存储中，高度保障用户的备份数据安全。

状态码 正常状态码 描述 200 OK 201 Created 202 Accepted 204 No Content 错误状态码 描述 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 409 Conflict 413 Request Entity Too Large 415 Unsupported Media Type 429 Too Many Requests 500 Internal Server Error 501 Not Implemented 503 Service Unavailable 父主题： 附录

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

请求URI 请求URI由如下部分组成（方括号部分可选）： {URI-scheme}://[{store-name}.]{Endpoint}/{resource-path}[?{query-string}] 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 请求使用的协议类型，如HTTP、HTTPS。HTTPS表示通过安全的HTTPS访问该资源，键值存储服务支持HTTP，HTTPS两种传输协议。 store-name 请求使用的仓名称，是可选部分，并不是每个API都有仓名称。存储仓的命名规范为{用户自定义前缀}-{KVS所在区域的区 域名 }-{用户的账号ID} ，例如：exampleprefix-cn-north-4-exampledomainid。如何获取账号ID请参见获取账号ID Endpoint 指定承载KVS服务端点的服务器域名或IP。Endpoint需要通过购买 VPC终端节点 ，创建内网域名来获取，具体操作请参见VPC终端节点对接KVS。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“创建表”API接口的resource-path为“/v1/create-table”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?store-name=exampleprefix-cn-north-4-exampledomainid”，表示仓名称为exampleprefix-cn-north-4-exampledomainid。 例如您需要在KVS的“华北-北京四”区域创建表，则需使用“华北-北京四”区域的Endpoint（kvs.cn-north-4.myhuaweicloud.com），并在具体API的URI部分找到resource-path（/v1/create-table），拼接起来如下所示。其中${store-name}为仓名。 1 https://${store-name}.kvs.cn-north-4.myhuaweicloud.com/v1/create-table 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/bson，有其他取值时会在具体接口中专门说明。 是 application/bson Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。

请求消息体（可选） 该部分可选。请求消息体通常以Bson格式发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），列举仓接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于创建表接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，斜体字段需要根据实际值填写，其中${store-name}为仓名，$YOUR_TABLE_NAME为表名，$YOUR_SHARD_KEY_NAME为分区键名称，$YOUR_SORT_KEY_NAME为排序键名称。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 POST https://${store-name}.kvs.cn-north-4.myhuaweicloud.com/v1/create-table Content-Type: application/bson { "table_name" : "$YOUR_TABLE_NAME", "primary_key_schema" : { "shard_key_fields" : [ { "name" : "$YOUR_SHARD_KEY_NAME", "order" : true } ], "sort_key_fields" : [ { "name" : "$YOUR_SORT_KEY_NAME", "order" : true } ] } } 到这里为止这个请求需要的内容就具备齐全了，您可以直接编写代码发送请求调用API。对于创建表接口，返回的响应体中包含了创建表的属性信息。表创建好以后，您就可以调用其他API执行向表中插入数据、查询表中数据等其他操作了。

API概览 表1 接口说明 类型 子类型 说明 仓接口 列举仓 一个账户下可以创建最多25个仓，每个仓可以创建最多100个store，响应中一次性返回所有仓名称。 创建表 在指定存储仓内创建表，表名在存储仓内唯一； 创建表时，指定主键模板及本地二级索引模板及全局二级索引模板。 列举表 指定存储仓列举创建的所有表。 表接口 查询表 指定存储仓查询表属性，如容量，规模，配额。 KV接口 上传单个kv 指定表，新建kv或覆盖已有kv，且满足表的key schema描述；允许指定条件执行。 查询单个kv 下载一个kv文档的全部内容，或者部分字段的内容。 更新单个kv 指定表，指定主键，指定更新文档的部分内容，如果是自描述文档，指定字段名；如果是二进制文档，指定偏移位置和长度；允许指定条件执行。 删除单个kv 指定表，指定主键，删除该文档；允许指定条件执行。 扫描所有kv 指定表，扫描表下所有kv；允许指定过滤条件。 扫描分区键内kv 指定表及分区键，携带条件查询kv；允许指定过滤条件。 批量写请求 批量写请求，其中可以携带一或多个表的不同kv的写操作，上传kv/删除kv。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在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的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 父主题： 使用前必读

概述 欢迎使用键值存储服务（Key-Value Storage Service, KVS）。键值存储服务提供完全托管的键值存储及索引服务，主要用于应用的键值类数据（如：元数据、描述数据、管理参数、状态数据）的存储，提供可预测的性能和无缝扩展，无需进行分区管理、硬件预置、集群扩展等操作。 您可以使用本文档提供API对键值存储服务进行相关操作，如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用键值存储服务API之前，请确保已经充分了解键值存储服务相关概念，详细信息请参见《用户指南》的“产品介绍”。 父主题： 使用前必读

请求示例 更新单个kv，设置表名为test-table-1，设置更新的kv分区键值为user1，排序键为test-file-1，设置更新的鑫数据为非结构化数据。 POST https://{endpoint}/v1/update-kv { "table_name" : "test-table-1", "primary_key" : { "owner" : "user-1", "filename" : "test-file-1" }, "update_fields" : { "set" : { "updateKey" : "updateValue" } } }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 table_name 是 String 表名，仓内唯一。 长度：[3, 63] 取值字符限制：[a-z0-9_-]+ primary_key 是 Document 用户自定义的主键名及值。 说明： 内容字段：主键字段名和值，组合索引多个元素。 condition_expression 否 condition_expression object 条件表达式，参见conditional小节，禁止携带主键字段。 update_fields 否 update_fields object 对kv_doc有效。 表3 condition_expression 参数 是否必选 参数类型 描述 single_field_expression 否 single_field_expression object 单字段条件。 multi_field_expression 否 multi_field_expression object 多字段条件，多个相同优先级的单字段条件。 composed_expression 否 composed_expression object 组合条件, 逐层同级的子表达式嵌套。 表4 multi_field_expression 参数 是否必选 参数类型 描述 logic 否 String 多字段条件，多个相同优先级的单字段条件。 expressions 是 Array of single_field_expression objects 多个相同逻辑操作的单字段条件。 表5 single_field_expression 参数 是否必选 参数类型 描述 field 是 String 条件字段。 func 是 String 条件函数，取值如"$gt", $lt","$gte", $lte" "$eq", "$ne", "$prefix", "$exists"。 value 否 Document value和value_array二选一。 value条件值，适用于除"$in", "$nin"外的func。 字段名无意义，可以传空，也可以传字段名。 $exists值为true/false。 说明： $prefix操作只适用于string和binary类型。 value_array 否 Array of strings "value"和"value_array"二选一。 "value_array" 条件值列表, 值用于"$in", "$nin"。 表6 composed_expression 参数 是否必选 参数类型 描述 logic 否 String 逻辑关系，取值如"$and", "$or", "$nor"。 expressions 是 Array of expression objects 多个相同优先级且相同逻辑的单字段或多字段条件。 表7 expression 参数 是否必选 参数类型 描述 single_field_expression 否 single_field_expression object 单字段条件。 multi_field_expression 否 single_field_expression object 多字段条件，多个相同优先级的单字段条件。 composed_expression 否 composed_expression object 组合条件, 逐层同级的子表达式嵌套。 表8 update_fields 参数 是否必选 参数类型 描述 set 否 Document 新增字段或覆盖1个或多个字段的值。 说明： 禁止修改sortkey的字段。 add 否 Document 对1个或多个字段做加法运算，并更新为运算后的值。 rmv 否 Array of strings 删除1个或多个字段。 数组元素为待删除字段名。

URI POST /v1/update-kv 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部