华为云用户手册

轮转凭据使用流程 流程说明： 创建一个轮转凭据。 设置凭据名称、标签等。 配置自动轮转策略。 应用系统在使用过程中需要访问数据库时，可以向 CS MS服务请求访问凭据，获取凭据值，调用API接口详情请参见查询凭据版本和凭据值。 应用系统通过访问返回的凭据值解析明文数据，获取账号和密码后，可以访问该用户对应的目标数据库。 开启自动轮转后，数据库实例所托管的密码将定时轮转更新，请确认使用该数据库实例的应用端已完成代码适配，可在数据库连接建立时，动态获取最新凭据。 不要轻易缓存凭据中的任何信息，避免账号密码轮转后失效，导致数据库连接失败。

密钥支持的轮换方式 表1 密钥轮换方式 密钥的来源或状态 支持的密钥轮换方式 默认密钥 不支持密钥轮换。 自定义密钥 支持自动轮换密钥或手动轮换密钥，根据密钥算法类型决定。 对称密钥：支持自动轮换密钥和手动轮换密钥。 非对称密钥：仅支持手动轮换密钥。 已禁用的主密钥 禁用主密钥后，KMS不会对它进行轮换。但是，密钥轮换状态不会发生改变，并且在主密钥处于禁用状态时不能对其进行更改。重新启用主密钥后，如果已禁用的自定义密钥已超过轮换周期，KMS会立即轮换。如果已禁用的自定义密钥少于轮换周期，KMS会恢复之前的密钥轮换计划。 关于禁用密钥的信息，请参见已禁用的主密钥。 计划删除的主密钥 对于计划删除的主密钥，KMS不会对它进行轮换。如果取消删除，将恢复之前的密钥轮换状态。如果计划删除的自定义密钥已超过轮换周期，KMS会立即轮换。如果计划删除的用户主密钥少于轮换周期，KMS会恢复之前的密钥轮换计划。 关于计划删除密钥的信息，请参见计划删除的主密钥。 用户可在“轮换策略”页面查看轮换详情，例如：上次轮换时间、轮换次数。

为什么需要轮换密钥 广泛重复的使用加密密钥，会对加密密钥的安全造成风险。为了确保加密密钥的安全性，建议您定期轮换密钥，更改原密钥的密钥材料。 定期轮换密钥有如下优点： 减少每个密钥加密的数据量 一个密钥的安全性与被它加密的数据量呈反比。数据量通常是指同一个密钥加密的数据总字节数或总消息数。 增强应对安全事件的能力 在系统安全设计的初期，设计密钥轮换功能并将其作为日常运维手段。这样可以使系统在特定安全事件发生时具备实际执行能力。 加强对数据的隔离能力 轮换密钥使得轮换前后产生的密文数据形成隔离效果。特定密钥的安全事件可以被快速定义影响范围，从而采取进一步措施。

密钥轮换的两种方法 华为云服务提供了两种密钥轮换方法： 手动轮换密钥 方式一：创建一个新的密钥B，使用密钥B替换当前正在使用的密钥A。 方式二：对密钥A的密钥材料进行更改，继续使用密钥A。 示例： 以OBS服务为例：需要手动轮换密钥时，用户先在KMS界面创建一个新的自定义密钥，后在OBS界面将原自定义密钥替换为新的自定义密钥。 图1 手动轮换密钥工作原理 自动轮换密钥 KMS会根据设置的轮换周期（默认365天）自动轮换密钥，系统自动生成一个新的密钥B，并替换当前使用的密钥A。自动轮换密钥只会更改主密钥的密钥材料，即加密操作中所使用的加密材料。不管密钥材料有没有变更或变更了多少次，该主密钥仍是相同的逻辑资源。主密钥的属性（密钥ID、别名、描述、权限）不会发生变化。 自动密钥轮换具有以下特点： 为现有的自定义密钥开启密钥轮换后，KMS自动为该自定义密钥生成新的密钥材料。 自动密钥轮换对主密钥所保护的数据无效。它不会轮换主密钥生成的数据密钥，也不会对任何受主密钥保护的数据重新加密，并且它无法减轻数据密钥泄露的影响。 图2 自动密钥轮换工作原理 KMS会保留与该自定义密钥关联的所有版本的自定义密钥。这使得KMS可以解密使用该自定义密钥加密的任何密文。 加密数据时，KMS会自动使用当前最新版本的自定义密钥来执行加密操作。 解密数据时，KMS会自动使用加密时所使用的自定义密钥来执行解密操作。

标签策略简介 标签策略是策略的一种类型，可帮助您在组织账号中对资源添加的标签进行标准化管理。标签策略对未添加标签的资源或未在标签策略中定义的标签不会生效。 例如：标签策略规定为某资源添加的标签A，需要遵循标签策略中定义的大小写规则和标签值。如果标签A使用的大小写、标签值不符合标签策略，则资源将会被标记为不合规。 标签策略有如下两种应用方式： 1. 事后检查 —— 资源标签如果违反标签策略，则在资源在合规性结果中显示为不合规。 2. 事前拦截 —— 标签策略开启强制执行后，则会阻止在指定的资源类型上完成不合规的标记操作。

约束条件 通过外部导入的SSH密钥对支持的加解密算法为： SSH-DSS（不推荐） SSH-ED25519 ECDSA-SHA2-NISTP256 ECDSA-SHA2-NISTP384 ECDSA-SHA2-NISTP521 SSH_RSA有效长度为：2048，3072，4096 支持托管的私钥文件格式为“.pem”。 如果是“.ppk”格式文件，请参考如何将“.ppk”格式的私钥文件转化为“.pem”格式进行转换。 导入的私钥如果被加密，则会上传失败。

操作指引 当用户需要在云上使用专属加密服务时，可通过Dedicated HSM界面购买专属加密实例。购买专属加密实例后，用户需要通过Dedicated HSM界面实例化专属加密实例。当用户收到Dedicated HSM邮寄的Ukey后，通过Ukey初始化，并管控专属加密实例。用户通过专属加密实例管理工具授权业务APP，允许业务用户通过业务APP访问专属加密实例。操作指引如图1所示。 图1 操作指引 操作指引说明如表1所示。 表1 操作指引说明 编号 操作步骤 说明 操作角色 1 购买专属加密实例 通过Dedicated HSM界面购买专属加密实例，详细操作请参见购买专属加密实例。 用户 2 激活专属加密实例 您购买专属加密实例后，通过Dedicated HSM界面实例化专属加密实例。您需要选择专属加密实例所属的虚拟私有云，以及专属加密实例的功能类型，详细操作请参见激活专属加密实例。 用户 3 获取UKey、配套初始化文档及软件 安全专家将通过您提供的Ukey收件地址将Ukey邮寄给您。 Ukey是Dedicated HSM提供给您的身份识别卡，此卡仅购买专属加密实例的用户持有，请妥善保管。 安全专家将会为您提供初始化专属加密实例的软件及相关指导文档。 如果您对软件或指导文档的使用有疑问，请联系安全专家进行指导。 说明： 可通过提交工单方式提供Ukey收件地址以及联系安全专家指导。 专属加密服务安全专家 4 初始化、管控（UKey认证） 在专属加密实例管理节点上安装为您提供的管理工具。 使用Ukey和管理工具初始化专属加密实例，并注册相应的管理员，管控专属加密实例，对密钥进行管理。 详细操作请参见初始化专属加密实例。 用户 5 安装安全代理软件并授权 在业务APP节点上安装为您提供的安全代理软件并执行相关初始化操作。 详细操作请参见安装安全代理软件并授权。 用户 6 访问 业务APP通过API或者SDK的方式访问专属加密实例。 用户

标签命名规则 每个标签由一对键值对（Key-Value）组成。 每个 数据加密 服务资源最多可以添加20个标签。 对于每个资源，每个标签键（Key）都必须是唯一的，每个标签键（Key）只能有一个值（Value）。 标签共由两部分组成：“标签键”和“标签值”，其中，“标签键”和“标签值”的命名规则如表 标签参数说明所示。 标签以键值对的形式表示，用于标识存储库，便于对存储库进行分类和搜索。此处的标签仅用于存储库的过滤和管理。一个存储库最多添加10个标签。 如您的组织已经设定数据加密服务的相关标签策略，则需按照标签策略规则为密钥、凭据等添加标签。标签如果不符合标签策略的规则，则可能会导致密钥、凭据创建失败，请联系组织管理员了解标签策略详情。 表1 标签参数说明 参数 规则 样例 标签键 必填。 对于同一个自定义密钥，标签键唯一。 长度不超过128个字符。 首尾不能包含空格。 不能以_sys_开头。 可以包含以下字符： 中文 英文 数字 空格 特殊字符_.:=+-@ cost 标签值 可以为空。 长度不超过255个字符。 可以包含以下字符： 中文 英文 数字 空格 特殊字符_.:=+-@ 100

约束条件 用户最多可创建100个自定义密钥，不包含默认密钥。创建副本密钥会占用该区域自定义密钥配额。 创建的对称密钥使用的是AES算法密钥，AES-256密钥可用于小量数据的加解密或用于加解密数据密钥，HMAC密钥用于数据完成性校验。 创建的非对称密钥使用的是RSA密钥或ECC密钥，RSA密钥可用于加解密、数字签名及验签，ECC密钥仅用于数字签名及验签。 因为默认密钥的别名后缀为“/default”，所以用户创建的密钥别名后缀不能为“/default”。 通过API接口方式调用KMS密钥时，每月每个密钥可免费调用20000次。。

相关操作 对象存储服务 中对象的服务端加密方法，具体请参见《对象存储服务控制台指南》的“使用服务端加密方式上传文件”章节。 云硬盘中数据加密方法，具体请参见《云硬盘用户指南》的“购买云硬盘”章节。 私有镜像的加密方法，具体请参见《 镜像服务 用户指南》的“加密镜像”章节。 云数据库中数据库实例的磁盘加密方法，具体请参见《云数据库RDS快速入门》的“购买实例”章节。 创建DEK、不含明文的DEK方法，具体请参见《数据加密服务API参考》的“创建数据密钥”与“创建不含明文数据密钥”章节。 用户应用程序的DEK加解密方法，具体请参见《数据加密服务API参考》的“加密数据密钥”与“解密数据密钥”章节。

操作步骤 登录KooMap管理控制台。 在左侧导航栏的“AR地图”下选择“项目管理”。 在“项目管理”页面，单击项目名称（蓝色字体），进入“项目详情”页面。 在数据列表选择预处理成功的数据，单击操作列下的“提交生产”。 图1 预览轨迹 在“空间预览轨迹”弹窗中核对轨迹是否与实际采图轨迹相符。 如您对轨迹不满意，则需要重新采集数据并上传数据再次进行预处理。 单击“提交生产”进行地图注册。 注册完成后，“地图注册”列显示“注册成功”。

操作步骤 登录KooMap管理控制台。 在左侧导航栏的“AR地图”下选择“项目管理”，然后在右侧页面单击“新增项目”。 在“新增项目”弹窗中，根据表1配置项目名称、行政区域以及项目描述，单击“确定”。 表1 新增项目 配置项 配置说明 项目名称 必填项。 输入项目名称。 名称不可重复。 行政区域 必选项。 选择项目覆盖的行政区域。 项目描述 选填项。 输入待新增项目的相关描述。 新建的项目将显示在项目列表最前端。

操作步骤 登录KooMap管理控制台。 在左侧导航栏的“AR地图”下选择“项目管理”。 在“项目管理”页面，参考表1管理项目。 表1 管理项目操作说明 操作 操作步骤 操作结果 项目详情查看 单击待查看项目操作列下的“查看详情”。 在“项目详情”中查看该项目的相关信息。 查看到项目的相关信息，包括项目的基本信息和该在项目内已上传的数据列表。 查询项目 在右上角设置项目名称、行政区域作为过滤条件。 单击，界面显示符合过滤条件的全部项目。 界面显示符合过滤条件的所有项目。 编辑项目 方式一： 单击待编辑项目操作列下的“编辑”。 在弹出来的“编辑项目信息”弹窗中，修改项目信息。 单击“确定”，完成信息的修改。 完成项目相关信息的修改。 方式二： 单击待编辑项目操作列下的“查看详情”。 在“项目详情”页面，单击“项目信息”右侧的。 在弹出来的“编辑项目信息”弹窗中，修改项目信息。 单击“确定”，完成信息的修改。 删除项目 单个删除： 单击项目操作列下的“删除”。 在弹出的窗口中单击“是”，完成删除。 项目被删除，并从界面的项目列表中移除。 批量删除： 勾选待删除的项目。 单击“批量删除”。 在弹出的窗口中单击“是”，完成删除。

操作步骤 登录KooMap管理控制台。 在左侧导航栏的“AR地图”下选择“项目管理”。 在“项目管理”页面，单击项目名称（蓝色字体），进入“项目详情”页面。 在数据列表选择注册成功的数据，单击操作列下的“注册调整”，在“注册调整”弹窗内核对地图注册结果。 如对注册结果不满意，可手动调整注册结果的坐标位置及角度。 图1 注册调整 单击“确定”进行地图生成阶段。 地图生产完成后，“地图生成”列显示为“生成成功”。

服务概览 开通AR地图运行服务或者AR地图生产服务后，您可在左侧导航栏选择“AR地图”下的“服务概览”菜单，做如下操作： 查看该服务相关信息，比如：产品名称、规格（仅适用于AR地图运行服务）、计费模式、套餐包剩余可用额度/总额度（仅适用于AR地图生产服务）以及状态。 退订AR地图运行服务或AR地图生产服务。 购买AR地图全景建图云服务套餐包。 AR地图运行服务具体使用指南请参考《开发指南》，AR地图生产服务的使用指南请参考新增与管理AR地图生产服务项目~部署/下线地图章节操作。 父主题： AR地图生产服务和AR地图运行服务使用指南

支持审计的关键操作列表 表1 云审计 服务支持的KooMap操作列表 操作名称 资源类型 事件名称 开通AR地图运行服务基础版 arapp_serv_base subsARAppServBase 退订AR地图运行服务基础版 arapp_serv_base unsubsARAppServBase 冻结AR地图运行服务基础版 arapp_serv_base freezeARAppServBase 解冻AR地图运行服务基础版 arapp_serv_base unfreezeARAppServBase 删除AR地图运行服务基础版 arapp_serv_base deleteARAppServBase 全景建图服务开通 panorama_con subsArPanoramaConstruct 全景建图服务退订 panorama_con unsubsArPanoramaConstruct 全景建图服务套餐包开通 panorama_con usagePackageOrderArPanoramaConstruct 全景建图服务冻结 panorama_con freezeArPanoramaConstruct 全景建图服务解冻 panorama_con unfreezeArPanoramaConstruct

创建桶 对象存储服务（Object Storage Service，OBS）是一个基于对象的海量存储服务，为客户提供海量、安全、高可靠、低成本的数据存储能力，包括：创建、修改、删除桶，上传、下载、删除对象等。对象（Object）是OBS中数据存储的基本单位，一个对象实际是一个文件的数据与其相关属性信息（元数据）的集合体。桶（Bucket）是OBS中存储对象的容器。 用户使用数据快递服务传输的数据，最终都以对象的形式保存在OBS的桶中。因此使用DES将数据存储到OBS，需先创建供数据存放的桶。创建桶具体操作请参见OBS创建桶。 父主题： Teleport方式详细指导

创建桶 对象存储服务（Object Storage Service，OBS）是一个基于对象的海量存储服务，为客户提供海量、安全、高可靠、低成本的数据存储能力，包括：创建、修改、删除桶，上传、下载、删除对象等。对象（Object）是OBS中数据存储的基本单位，一个对象实际是一个文件的数据与其相关属性信息（元数据）的集合体。桶（Bucket）是OBS中存储对象的容器。 用户使用数据快递服务传输的数据，最终都以对象的形式保存在OBS的桶中。因此使用DES将数据存储到OBS，需先创建供数据存放的桶。创建桶具体操作请参见OBS创建桶。 用户可根据数据目录的个数来决定创建桶的个数，一个服务单最多可使用10个桶。 父主题： 磁盘方式详细指导

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult CopyPartOutput 参数解释： 操作成功后的结果数据，详见CopyPartOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 CopyPartOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ETag string 参数解释： 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 LastModified string 参数解释： 目标段的最近一次修改时间（UTC时间）。 约束限制： 日期格式必须为ISO8601的格式。 例如：2018-01-01T00:00:00.000Z，表示最后一次修改时间为2018-01-01T00:00:00.000Z。 默认取值： 无 PartNumber number 参数解释： 段号。 取值范围： [1,10000]的非负整数。 默认取值： 无 SseKms string 参数解释： 作为请求参数时必选 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围： 可选值：kms，即选择SSE-KMS方式加密对象。 默认取值： 无 SseKmsKey string 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？(Harmony SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 SseC string 参数解释： 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 取值范围： 可选值：AES256，即选择SSE-C方式加密对象。 默认取值： 无 SseCKeyMd5 string 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==。 默认取值： 无

接口约束 您必须是桶拥有者或拥有复制段的权限，才能复制段。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 复制段的结果不能仅根据HTTP返回头域中的status_code来判断请求是否成功，头域中status_code返回200时表示服务端已经收到请求，且开始处理复制段请求。复制是否成功会在响应消息的body中，只有body体中有ETag标签才表示成功，否则表示复制失败。

功能说明 初始化分段上传任务后，通过分段上传任务的ID，复制段到指定桶中。 多段上传任务创建后，用户可以通过指定多段上传任务号，为特定的任务上传段。添加段的方式还包括调用段复制接口。允许用户将已上传对象的一部分或全部复制为段。 将源对象object复制为一个段part1，如果在复制操作之前part1已经存在，复制操作执行之后，旧的段数据part1会被新复制的段数据覆盖。复制成功后，只能列举到最新的段part1，旧的段数据将会被删除。因此在使用复制段接口时请确保目标段不存在或者已无价值，避免因复制段导致数据误删除。复制过程中源对象object无任何变化。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input CopyPartInput 必选 参数解释： 复制段接口入参，详见CopyPartInput。 表2 CopyPartInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 目标桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 PartNumber number 必选 参数解释： 段号。 取值范围： [1,10000]的非负整数。 默认取值： 无 UploadId string 必选 参数解释： 分段上传任务的ID。例如：000001648453845DBB78F2340DD460D8 取值范围： 长度为32的字符串。 默认取值： 无 CopySource string 必选 参数解释： 用来指定复制对象操作的源桶名以及源对象名。当源对象存在多个版本时，通过versionId参数指定版本源对象。 示例：source_bucket/sourceObject?versionId=G001117FCE89978B0000401205D5DC9A 约束限制： 中文字符与%，需要进行URL编码。 默认取值： 无

HTTP状态码(Harmony SDK) OBS服务端遵照HTTP规范，在接口调用完成均会返回标准的HTTP状态码，HTTP状态码分类以及OBS中常见的HTTP状态码如下： HTTP状态码分类： 分类 分类描述 1XX 信息，服务器收到请求，需要请求者继续执行操作，一般对用户调用函数不可见。 2XX 成功，操作被成功接收并处理。 3XX 重定向，需要进一步的操作以完成请求。 4XX 客户端错误，请求包含语法错误或无法完成请求。 5XX 服务器错误，服务器在处理请求的过程中发生了错误 OBS中常见的HTTP状态码及其含义： HTTP状态码 描述 常见原因 400 Bad Request 请求参数错误 请求参数不合法。 客户端携带MD5请求后一致性校验失败。 无效的参数（使用SDK时传递了不合法的参数）。 无效的桶名（使用了不合法的桶名）。 403 Forbidden 拒绝访问 请求的签名不匹配（一般是AK/SK错误）。 权限不足（账号对请求的资源无权限）。 账号欠费。 桶的空间不足（出现在对桶设置了配额的场景）。 无效的AK。 客户端时间和服务端时间相差过大（客户端所在机器的时间与NTP服务不同步）。 404 Not Found 请求的资源不存在 桶不存在。 对象不存在。 桶的策略配置不存在（桶CORS配置不存在、桶Policy配置不存在等）。 分段上传任务不存在。 405 Method Not Allowed 请求的方法不支持 请求的方法/特性未在该桶所在的区域上线。 408 Request Timeout 请求超时 服务端与客户端Socket连接超时。 409 Conflict 请求冲突 在不同区域重复创建桶名桶。 尝试删除非空桶。 500 Internal Server Error 服务端内部错误 服务端内部错误。 503 Service Unavaliable 服务不可用 服务端暂时不可访问 父主题： 异常处理(Harmony SDK)

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult GetBucketWebsiteOutput 参数解释： 操作成功后的结果数据，详见GetBucketWebsiteOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 GetBucketWebsiteOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 RedirectAllRequestsTo RedirectAllRequestTo 参数解释： 所有请求重定向规则，详见RedirectAllRequestTo。 IndexDocument IndexDocument 可选 参数解释： 默认页面配置，详见IndexDocument。 ErrorDocument ErrorDocument 可选 参数解释： 错误页面配置，详见ErrorDocument。 RoutingRules RoutingRule[] 可选 参数解释： 请求重定向规则列表，详见RoutingRule。 表7 RedirectAllRequestsTo 参数名称 参数类型 是否可选 描述 HostName string 如果RedirectAllRequestsTo 设置必选 参数解释： 重定向时使用的 域名 。如 www.example.com。 约束限制： 域名需符合域名规范。 默认取值： 无 Protocol string 可选 参数解释： 重定向请求时使用的协议。 取值范围： 协议类型可选：http、https。 默认取值： 无 表8 IndexDocument 参数名称 参数类型 是否必选 描述 Suffix string 如果IndexDocument 设置则参数时必选 参数解释： 该字段被追加在对文件夹的请求的末尾（例如：Suffix参数设置为“index.html”，请求的是“samplebucket/images/”，返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容）。 取值范围： 该字段不能为空或者包含“/”字符。 默认取值： 无 表9 ErrorDocument 参数名称 参数类型 是否必选 描述 Key string 如果ErrorDocument 设置时可选 参数解释： 当4XX错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 表10 RoutingRule 参数名称 参数类型 是否可选 描述 Condition Condition 可选 参数解释： 重定向规则生效需要满足的条件。 取值范围： 匹配条件选择范围详见Condition。 默认取值： 无 Redirect Redirect 如果RoutingRule 设置则参数时必选 参数解释： 重定向请求时的具体信息，详见Redirect。 表11 Condition 参数名称 参数类型 是否必选 描述 KeyPrefixEquals string 可选 参数解释： 重定向生效时的对象名前缀。当向对象发送请求时，如果对象名前缀等于这个值，那么重定向生效。 例如：重定向ExamplePage.html对象的请求，KeyPrefixEquals设为ExamplePage.html。 约束限制： 与HttpErrorCodeReturnedEquals参数不可同时使用，两者二选一。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 HttpErrorCodeReturnedEquals string 可选 参数解释： 重定向生效时的HTTP错误码。当发生错误时，如果错误码等于这个值，那么重定向生效。 例如：当返回的HTTP错误码为404时重定向到NotFound.html，可以将Condition中的HttpErrorCodeReturnedEquals设置为404，Redirect中的ReplaceKeyWith设置为NotFound.html。 约束限制： 与KeyPrefixEquals参数不可同时使用，两者二选一。 取值范围： 可参见错误码。 默认取值： 无 表12 Redirect 参数名称 参数类型 是否必选 描述 Protocol string 作为请求参数时可选 参数解释： 重定向请求时使用的协议。 取值范围： 协议类型可选范围：http、https。 默认取值： 无 HostName string 作为请求参数时可选 参数解释： 重定向请求时使用的域名。 默认取值： 无 ReplaceKeyPrefixWith string 作为请求参数时可选 参数解释： 重定向请求时使用的对象名前缀。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 ReplaceKeyWith string 作为请求参数时可选 参数解释： 重定向请求时使用的对象名。 约束限制： 不可与ReplaceKeyPrefixWith同时使用。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 HttpRedirectCode string 作为请求参数时可选 参数解释： 重定向请求时响应中的HTTP状态码，详见状态码。 默认取值： 无

接口约束 您必须是桶拥有者或拥有获取桶的网站配置的权限，才能获取桶的网站配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketWebsite权限，如果使用桶策略则需授予GetBucketWebsite权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input BucketRequestInput 必选 参数解释： 获取桶的网站配置接口接口入参，详见 BucketRequestInput。 表2 BucketRequestInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无

OBS服务端错误码(Harmony SDK) 在向OBS系统发出请求后，如果遇到错误，会在响应中包含响应的错误码描述错误信息。对象存储访问服务的错误码如表1所示。 表1 错误码 状态码 错误码 错误信息 处理措施 301 Moved Permanently PermanentRedirect 尝试访问的桶必须使用指定的地址，请将以后的请求发送到这个地址。 按照返回的重定向地址发送请求。 301 Moved Permanently WebsiteRedirect Website请求缺少bucketName。 携带桶名后重试。 307 Moved Temporarily TemporaryRedirect 临时重定向，当DNS更新时，请求将被重定向到桶。 会自动重定向，也可以将请求发送到重定向地址。 400 Bad Request BadDigest 客户端指定的对象内容的MD5值与系统接收到的内容MD5值不一致。 检查头域中携带的MD5与消息体计算出来的MD5是否一致。 400 Bad Request BadDomainName 域名不合法。 使用合法的域名。 400 Bad Request BadRequest 请求参数不合法。 根据返回的错误消息体提示进行修改。 400 Bad Request CustomDomainAreadyExist 配置了已存在的域。 已经配置过了，不需要再配置。 400 Bad Request CustomDomainNotExist 删除不存在的域。 未配置或已经删除，无需删除。 400 Bad Request EntityTooLarge 通过SDK或API的PUT上传、POST上传和追加写超过5GB的文件 上传段超过5GB 设置的桶配置超过20KB 超过post表单中policy限制的文件大小（用户可自定义） 通过SDK或API的多段上传以及SDK的断点续传超过48.8TB的文件 修改上传的policy中的条件或者减少对象大小。 400 Bad Request EntityTooSmall 上传段除最后一段小于100KB 小于post表单中policy限制的文件大小（用户可自定义） 修改上传的policy中的条件或者增加对象大小。 400 Bad Request IllegalLocationConstraintException 用户未带Location在非默认Region创桶。 请求发往默认Region创桶或带非默认Region的Location创桶。 400 Bad Request IncompleteBody 由于网络原因或其他问题导致请求体未接受完整。 重新上传对象。 400 Bad Request IncorrectNumberOfFilesInPost Request 每个POST请求都需要带一个上传的文件。 带上一个上传文件。 400 Bad Request InvalidArgument 无效的参数。 根据返回的错误消息体提示进行修改。 400 Bad Request InvalidBucket 请求访问的桶已不存在。 更换桶名。 400 Bad Request InvalidBucketName 请求中指定的桶名无效，超长或带不允许的特殊字符。 更换桶名。 400 Bad Request InvalidContentLength Content-Length头域内容有误。 请检查封装头域或者提交工单寻求技术支持。 请检查封装头域或联系技术支持。 400 Bad Request InvalidDefaultStorageClass 存储类别不可用。 请确认能够使用的存储类别。 400 Bad Request InvalidEncryptionAlgorithmError 错误的加密算法。下载SSE-C加密的对象，携带的加密头域错误，导致不能解密。 携带正确的加密头域下载对象。 400 Bad Request InvalidLocationConstraint 创建桶时，指定的Location不合法或不存在。 指定正确的Location创桶。 400 Bad Request InvalidPart 一个或多个指定的段无法找到。这些段可能没有上传，或者指定的entity tag与段的entity tag不一致。 按照正确的段和entity tag合并段。 400 Bad Request InvalidPartOrder 段列表的顺序不是升序，段列表必须按段号升序排列。 按段号升序排列后重新合并。 400 Bad Request InvalidPolicyDocument 表单中的内容与策略文档中指定的条件不一致。 根据返回的错误消息体提示修改构造表单的policy重试。 400 Bad Request InvalidRedirectLocation 无效的重定向地址。 指定正确的地址。 400 Bad Requestvdf InvalidRequest 无效请求。 根据返回的错误消息体提示进行修改。 400 Bad Request InvalidRequestBody 请求体无效，需要消息体的请求没有上传消息体。 按照正确的格式上传消息体。 400 Bad Request InvalidTargetBucketForLogging delivery group对目标桶无ACL权限。 对目标桶配置ACL权限后重试。 400 Bad Request InvalidTag 桶标签不合规，不符合标签策略定义的规范，标签策略相关信息详见标签策略。 请更换符合标签策略规范的标签值。 400 Bad Request KeyTooLongError 提供的Key过长。 使用较短的Key。 400 Bad Request KMS.DisabledException SSE-KMS加密方式下，主密钥被禁用。 更换密钥后重试，或提交工单寻求技术支持。 400 Bad Request KMS.NotFoundException SSE-KMS加密方式下，主密钥不存在。 携带正确的主密钥重试。 400 Bad Request MalformedACLError 提供的XML格式错误，或者不符合要求的格式。 使用正确的XML格式重试。 400 Bad Request MalformedError 请求中携带的XML格式不正确。 使用正确的XML格式重试。 400 Bad Request MalformedLoggingStatus Logging的XML格式不正确。 使用正确的XML格式重试。 400 Bad Request MalformedPolicy Bucket policy检查不通过。 根据返回的错误消息体提示结合桶policy的要求进行修改。 400 Bad Request MalformedQuotaError Quota的XML格式不正确。 使用正确的XML格式重试。 400 Bad Request MalformedXML 当用户发送了一个配置项的错误格式的XML会出现这样的错误。 使用正确的XML格式重试。 400 Bad Request MaxMessageLengthExceeded 拷贝对象，带请求消息体。 拷贝对象不带消息体重试。 400 Bad Request MetadataTooLarge 元数据消息头超过了允许的最大元数据大小。 减少元数据消息头。 400 Bad Request MissingRegion 请求中缺少Region信息，且系统无默认Region。 请求中携带Region信息。 400 Bad Request MissingRequestBodyError 当用户发送一个空的XML文档作为请求时会发生。 提供正确的XML文档。 400 Bad Request MissingRequiredHeader 请求中缺少必要的头域。 提供必要的头域。 400 Bad Request MissingSecurityHeader 请求缺少一个必须的头。 提供必要的头域。 400 Bad Request MultipleContentLengths 多个Content-Length头域。 请检查封装头域或者提交工单寻求技术支持。 400 Bad Request TooManyBuckets 用户拥有的桶的数量达到了系统的上限，并且请求试图创建一个新桶。 删除部分桶后重试。 400 Bad Request TooManyCustomDomains 配置了过多的用户域。 删除部分用户域后重试。 400 Bad Request TooManyWrongSignature 因高频错误请求被拒绝服务。 更换正确的Access Key后重试。 400 Bad Request UnexpectedContent 该请求需要消息体而客户端没带，或该请求不需要消息体而客户端带了。 根据说明重试。 400 Bad Request UserKeyMustBeSpecified 该操作只有特殊用户可使用。 请提交工单寻求技术支持。 400 Bad Request FileGatewayBucket 并行文件系统不支持配置桶清单。 请使用对象桶。 403 Forbidden AccessDenied 拒绝访问，请求没有携带日期头域或者头域格式错误。 请求携带正确的日期头域。 403 Forbidden AccessForbidden 权限不足，桶未配置CORS或者CORS规则不匹配。 修改桶的CORS配置，或者根据桶的CORS配置发送匹配的OPTIONS请求。 403 Forbidden AllAccessDisabled 用户无权限执行某操作。桶名为禁用关键字。 更换桶名。 403 Forbidden DeregisterUserId 用户已经注销。 充值或重新开户。 403 Forbidden InArrearOrInsufficientBalance 用户欠费或余额不足而没有权限进行某种操作。 充值。 403 Forbidden InsufficientStorageSpace 存储空间不足。 超过配额限制，增加配额或删除部分对象。 403 Forbidden InvalidAccessKeyId 系统记录中不存在用户提供的Access Key Id。 携带正确的Access Key Id。 403 Forbidden InvalidObjectState 归档对象不能直接下载，需要先进行恢复才能下载。 先对对象进行恢复操作。 403 Forbidden NotSignedUp 您的账户还没有在系统中注册，必须先在系统中注册了才能使用该账户。 先注册OBS服务。 403 Forbidden RequestTimeTooSkewed 客户端发起请求的时间与OBS服务端的时间相差太大。 出于安全目的，OBS会校验客户端与OBS服务端的时间差，当该时间差大于15分钟时，OBS服务端会拒绝您的请求，从而出现此报错。 请检查客户端时间是否与当前OBS服务端时间相差太大。请根据本地UTC时间调整客户端时间后再访问。 403 Forbidden SignatureDoesNotMatch 请求中带的签名与系统计算得到的签名不一致。 检查您的Secret Access Key和签名计算方法。详细排查方法请参见签名不匹配（SignatureDoesNotMatch）如何处理。 403 Forbidden VirtualHostDomainRequired 未使用 虚拟主机 访问域名。 Host使用虚拟主机访问域名。 须知： 除获取桶列表之外的所有接口，都应当包含桶名。OBS基于DNS解析性能和可靠性的考虑，要求凡是携带桶名的请求，在构造URL的时候都必须将桶名放在domain前面，形成三级域名形式，又称为虚拟主机访问域名。 例如，如果您有一个位于cn-north-4区域的名为test-bucket的桶，期望访问桶中一个名为test-object对象的acl，正确的访问URL为https://test-bucket.obs.cn-north-4.myhuaweicloud.com/test-object?acl 403 Forbidden Unauthorized 用户未实名认证。 请实名认证后重试。 404 Not Found NoSuchBucket 指定的桶不存在。 先创桶再操作。 404 Not Found NoSuchBucketPolicy 桶policy不存在。 先配置桶policy。 404 Not Found NoSuchCORSConfiguration CORS配置不存在。 先配置CORS。 404 Not Found NoSuchCustomDomain 请求的用户域不存在。 先设置用户域。 404 Not Found NoSuchKey 指定的Key不存在。 先上传对象。 404 Not Found NoSuchLifecycleConfiguration 请求的LifeCycle不存在。 先配置LifeCycle。 404 Not Found NoSuchUpload 指定的多段上传不存在。Upload ID不存在，或者多段上传已经终止或完成。 使用存在的段或重新初始化段。 404 Not Found NoSuchVersion 请求中指定的version ID与现存的所有版本都不匹配。 使用正确的version ID。 404 Not Found NoSuchWebsiteConfiguration 请求的Website不存在。 先配置Website。 405 Method Not Allowed MethodNotAllowed 指定的方法不允许操作在请求的资源上。 对应返回的Message为：Specified method is not supported. 方法不允许。 请确认该区域是否支持所调用的接口功能。各功能发布的区域请参见OBS功能总览。 405 Method Not Allowed FsNotSupport posix桶不支持该API。 方法不允许。 请确认该区域是否支持所调用的接口功能。各功能发布的区域请参见OBS功能总览。 405 Method Not Allowed FeatureNotAvailable 不支持该特性。 服务端不支持特性，请提交工单寻求技术支持。 408 Request Timeout RequestTimeout 用户与Server之间的socket连接在超时时间内没有进行读写操作。 检查网络后重试，或提交工单寻求技术支持。 409 Conflict BucketAlreadyExists 请求的桶名已经存在。桶的命名空间是系统中所有用户共用的，选择一个不同的桶名再重试一次。 更换桶名。 409 Conflict BucketAlreadyOwnedByYou 发起该请求的用户已经创建过了这个名字的桶，并拥有这个桶。 不需要再创桶了。 409 Conflict BucketNotEmpty 用户尝试删除的桶不为空。 先删除桶中对象，然后再删桶。 409 Conflict InvalidBucketState 无效的桶状态，配置跨Region复制后不允许关闭桶多版本。 不关闭桶的多版本或取消跨Region复制。 409 Conflict OperationAborted 另外一个冲突的操作当前正作用在这个资源上，请重试。 等待一段时间后重试。 409 Conflict ServiceNotSupported 请求的方法服务端不支持。 服务端不支持，请提交工单寻求技术支持。 409 Conflict FsObjectConflict 并行文件系统中，文件和目录不支持互相覆盖，或者重命名的目标文件已经存在。 请确认待覆盖的目标类型（是文件还是目录），请确认重命名的目标文件是否存在。 409 ObjectNotAppendable ObjectNotAppendable 该对象不支持追加上传 请确认桶类型，并行文件系统不支持追加上传。请确认对象类型，归档存储和深度归档存储对象不支持追加上传。 411 Length Required MissingContentLength 必须要提供HTTP消息头中的Content-Length字段。 提供Content-Length消息头。 412 Precondition Failed PreconditionFailed 用户指定的先决条件中至少有一项没有包含。 根据返回消息体中的Condition提示进行修改。 414 URI Too Long Request-URI Too Large 请求使用的URI过长 请减少URI的长度。 416 Client Requested Range Not Satisfiable InvalidRange 请求的range不可获得。 携带正确的range重试。 500 Internal Server Error InternalError 系统遇到内部错误，请重试。 请提交工单寻求技术支持。 501 Not Implemented ServiceNotImplemented 请求的方法服务端没有实现。 当前不支持，请提交工单寻求技术支持。 503 Service Unavailable ServiceUnavailable 服务器过载或者内部错误异常。 等待一段时间后重试，或提交工单寻求技术支持。 503 Service Unavailable SlowDown 请降低请求频率。 请降低请求频率。 父主题： 异常处理(Harmony SDK)

返回结果 表9 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表10 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOutput 参数解释： 操作成功后的结果数据，详见BaseResponseOutput。 约束限制： 当Status大于300时为空。 表11 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表12 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

接口约束 尽量避免目标桶名中带有“.”，否则通过HTTPS访问时可能出现客户端校验证书出错。 设置桶的网站配置请求消息体的上限是10KB。 您必须是桶拥有者或拥有设置桶的网站配置的权限，才能设置桶的网站配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketWebsite权限，如果使用桶策略则需授予PutBucketWebsite权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input SetBucketWebsiteInput 必选 参数解释： 设置桶的网站配置接口入参，详见SetBucketWebsiteInput。 表2 SetBucketWebsiteInput 参数名称 参数类型 是否可选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 RedirectAllRequestsTo RedirectAllRequestTo 可选 参数解释： 所有请求重定向规则，详见RedirectAllRequestTo。 IndexDocument IndexDocument 可选 参数解释： 默认页面配置，详见IndexDocument。 ErrorDocument ErrorDocument 可选 参数解释： 错误页面配置，详见ErrorDocument。 RoutingRules RoutingRule[] 可选 参数解释： 请求重定向规则列表，详见RoutingRule。 ErrorDocument、IndexDocument和RoutingRules必须配套使用，且与RedirectAllRequestsTo互斥。当设置了这三个字段时，不能设置RedirectAllRequestsTo；反之，当设置了RedirectAllRequestsTo时，不能设置ErrorDocument、IndexDocument和RoutingRules。 当ErrorDocument、IndexDocument和RoutingRules三个字段一起使用时，RoutingRules可为空。 ErrorDocument、IndexDocument、RoutingRules与RedirectAllRequestsTo不能全为空。