华为云用户手册

日志接入 主机接入LTS后无法采集到日志？ 在 AOM 关闭超额继续采集日志开关，会影响LTS收集日志吗？ 使用ICAgent收集日志时CPU占用较高怎么处理？ 云日志服务LTS 支持采集的日志类型和文件类型有哪些？ 如何在LTS页面关闭CCE标准输出日志采集到AOM？ 使用ICAgent采集日志时，推荐的日志轮转方案是什么？ 是否支持Log4j插件上报日志到LTS？ LTS配置日志接入后多久有日志？ 通过ICAgent接入LTS后无法采集到日志？

使用LTS SDK相关问题 本文介绍使用LTS SDK的常见问题和相关报错的处理方法。 端侧SDK日志接入LTS时需要注意什么？ 答：请用户在使用端侧SDK日志接入LTS时，建议提前做好一键关闭日志上报、逐步提升上报流量等措施，做到及时止损，如果您的移动端日志流量非常大，请提前知会LTS技术支持为您提前预留资源。 端侧SDK中的上报日志report接口和立即上报日志reportImmediately接口如何选择？ 答：建议使用上报日志report接口，通过调整上报策略，配置上报间隔、上报大小等参数。重要紧急的数据使用立即上报日志reportImmediately接口，即可进行立即上报。 端侧SDK上报的数据是放到labels参数还是contents参数？ 答：固定数据（例如用户ID、设备型号、渠道、系统、网络等）可以放到labels参数，方便进行维度分析；其他数据建议都放到contents参数，然后按需进行索引配置。 集成接入SDK包后对于客户App大小和性能有什么影响吗？ 答：iOS端App大小增加50KB左右，Android端App大小增加200KB左右，Web端大小可以忽略不计。在上传日志数据100条/每秒的情况下对性能没有影响。 iOS SDK和Android SDK支持哪些版本？ 答：iOS SDK支持iOS10及以上版本，Android SDK支持Android7及以上版本。如果需要支持更低版本，请提交工单申请开通。 按文档要求操作接入后，但在LTS控制台查询不到上报的日志数据？ 答：首先检查AK，SK，region，projectId这四个参数是否正确，更多信息请参考SDK接入。其次，在App控制台查看报错提示，详细请参考错误码。最后，请检查端侧权限是否已开通LTS白名单，若有需要，请提交工单申请开通。 App控制台上报日志失败，报错提示接口403？ 答：在 云日志 服务控制台查看日志流是否开启了匿名上报。详细请参考日志流章节中如何开启匿名写入。 集成接入SDK的时候提示SDK初始化失败。 答：可以先开启debug模式，每个参数都会打印，根据提示可以定位到初始化失败的原因。 端侧上报一条日志长度和大小限制。 答：一条日志长度是30720个字符，超过该长度的内容会被删除，只截取30*1024长度的内容，然后以字符串方式上报LTS。上报日志的大小限制为1MB。 端侧SDK日志的上报策略是什么样的？ 答：端侧SDK日志有时间和空间维度的自定义上报策略，上报间隔默认3s，上报条数默认200条，哪个先触发就先上报。 端侧SDK日志发送是异步发送还是同步发送？ 答：端侧SDK日志发送是异步发送。 LTS能支持多大的端侧SDK并发量？ 答：端侧SDK并发量与资源容量大小有关，理论上来说只要LTS资源足够，并发量不是问题。若需要支持更多端侧SDK并发量，请提交工单申请开通。 父主题： SDK接入

主机管理 在Windows环境下ICAgent安装失败并提示SERVICE STOP怎么办？ 在LTS页面升级ICAgent失败怎么办？ 在LTS页面无法查询新产生的日志怎么办？ ICAgent安装完成后反复重启怎么办？ 在LTS页面完成ICAgent安装后显示离线怎么办？ ICAgent安装完成后，在LTS页面不显示怎么办？ 如何在VPCEP控制台创建终端节点？ 如何获取AK/SK？ 如何通过创建委托授权安装ICAgent？

成本对比 场景一： 假设客户每天原始日志100GB（日志平均速率1.16MB/s），日志平均存储30天，30天原始日志总量为3000GB，日志存储方式为一主一副本。 根据Elasticsearch官方推荐，在一主一副本存储方式下，原始日志+副本数据+索引数据等合计占用的存储空间约为原始日志大小2.2倍，另外由于ES集群存在写不均匀且磁盘不能被耗尽，因此为了存储3000GB原始日志，至少需要准备3000GB*2.2（存储膨胀）*2（50%磁盘冗余） = 13200GB磁盘。 搭建ES最小典型配置是3台E CS （16U64G5TB），kafka双副本能支持缓存最近12小时的日志。 表1 自建ELK 大类 小类 月成本（合计：12597元） 费用占比 搭建ES 3 * ECS（C6 16U64G） 3*1999=5997元 47.6% 云硬盘EVS（高IO 15TB） 0.35*15*1024=5376元 42.7% 搭建KAFKA 3 * ECS（2U4G） 3*208=624元 4.9% 云硬盘EVS（超高IO 3*200GB） 600元 4.7% LTS使用价格计算器，计算出来月成本约为2102元，使用LTS的成本约为自建ELK成本的16.7%，原因是在小日志量场景下，自建ELK起步资源成本很高，相比于按需付费的LTS，有很大劣势。 场景二： 假设客户每天原始日志1TB（日志平均速率11.6MB/s），日志平均存储7天，7天原始日志总量为7TB，日志存储方式为一主一副本。根据Elasticsearch官方推荐，在一主一副本存储方式下，原始日志+副本数据+索引数据等合计占用的存储空间约为原始日志大小2.2倍，另外由于ES集群存在写不均匀且磁盘不能被耗尽，因此为了存储7TB原始日志，至少需要准备7TB*2.2（存储膨胀）*2（50%磁盘冗余） = 31 TB磁盘。 搭建ES最小典型配置是3台ECS（16U64G10TB），kafka双副本能支持缓存最近12小时的日志 表2 自建ELK 大类 小类 月成本（合计：18931元） 费用占比 搭建ES 3 * ECS（C6 16U64G） 3*1999=5997元 31.7% 云硬盘EVS（高IO 31TB） 0.35*31*1024=11110元 58.7% 搭建KAFKA 3 * ECS（2U4G） 3*208=624元 3.3% 云硬盘EVS（超高IO 3*400GB） 1200元 6.3% LTS使用价格计算器，计算出来月成本约为13408元，使用LTS的成本约为自建ELK成本的71%，原因是LTS的存储收费是按用量付费，自建ELK为了保证集群的正常运行需要留有很多磁盘冗余。 场景三： 假设客户每天原始日志5TB（日志平均速率58MB/s），日志平均存储30天，30天原始日志总量为150TB，日志存储方式为一主一副本。 根据Elasticsearch官方推荐，在一主一副本存储方式下，原始日志+副本数据+索引数据等合计占用的存储空间约为原始日志大小2.2倍，另外由于ES集群存在写不均匀且磁盘不能被耗尽，因此为了存储150TB原始日志，至少需要准备150TB*2.2（存储膨胀）*2（50%磁盘冗余） = 660 TB磁盘。 搭建ES最小典型配置是66台ECS（16U64G10TB），kafka双副本能支持缓存最近12小时的日志 表3 自建ELK 大类 小类 月成本（合计：374202元） 费用占比 搭建ES 66 * ECS（C6 16U64G） 66*1999=131934元 35.3% 云硬盘EVS（高IO 660TB） 0.35*660*1024=236544元 63.2% 搭建KAFKA 3 * ECS（2U4G） 3*208=624元 0.2% 云硬盘EVS（超高IO 3*1700GB） 5100元 1.4% LTS使用价格计算器，计算出来月成本约为107655元，使用LTS的成本约为自建ELK成本的28.8%，原因是LTS的存储收费是按用量付费，自建ELK为了保证集群的正常运行需要留有很多磁盘冗余。

功能对比 云日志服务LTS在功能特性的完备度、日志搜索分析性能方面对比ELK有明显的优势，详细对比请见如下表格： 特性 子特性 LTS ELK 描述 日志采集 云服务日志采集 ☆☆☆☆☆ 无 ELK：不支持采集云服务日志。 LTS：云服务租户面日志统一采集到LTS。 虚机和容器日志采集 ☆☆☆☆☆ ☆☆☆☆ ELK：使用logstash或者filebeat等开源采集器采集日志。 LTS：使用ICAgent采集日志，有提供向导页面，上手难度低。 多语言SDK日志采集 ☆☆☆ 无 ELK：不支持。 LTS：提供java SDK直接上报日志到LTS 主机组管理（主机动态扩缩容） ☆☆☆☆☆ 无 ELK：不支持。 LTS：提供主机管理、主机组管理能力，主机组支持自定义标识主机组，可以管理动态扩缩容主机组。 日志结构化解析 ☆☆☆☆ ☆☆☆☆☆ ELK：基于采集器实现自定义日志结构化解析。 LTS：提供结构化解析能力，可以正则表达式、JSON、分隔符、自定义模板等方式解析日志。 日志搜索 关键词搜索、模糊搜索、快速分析 ☆☆☆☆☆ ☆☆☆☆☆ ELK和LTS：提供类似的日志关键词搜索能力。 实时日志查看 ☆☆☆☆☆ 无 ELK：未提供实时日志查看页面。 LTS：提供实时日志查看页面。 百亿日志秒级搜索 ☆☆☆☆☆ ☆☆ ELK：自建ELK受限于机器资源数量，搜索海量日志时耗时较长。 LTS：利用公有云海量的弹性计算资源，百亿日志可以在3秒内返回搜索结果。 千亿级日志迭代搜索 ☆☆☆☆☆ 无 ELK：无法直接搜索千亿条日志，会出现响应超时。 LTS：提供迭代搜索能力，用户可以直接搜索千亿条日志。 日志管理规模 百PB级 百TB级 ELK：经常要关注机器扩容，费时费力。 LTS：按需付费，LTS自动管理百PB级日志，不用关心底层资源消耗情况。 日志搜索 SQL分析日志 ☆☆☆☆☆ ☆☆ ELK：SQL性能差，语法上不支持嵌套SQL。 LTS：SQL性能强，支持嵌套SQL。 日志搜索 SQL函数 ☆☆☆☆☆ ☆☆ ELK：只支持最基础的SQL统计函数。 LTS：在基础SQL函数基础上，提供了大量的扩展函数，例如IP函数、统计函数、环比同比函数、URL函数等，极大扩展了使用场景。 日志搜索 可视化图表 ☆☆☆☆ ☆☆☆ LTS：提供了表格、折线图、饼图、柱状图等多种可视化图表。 日志搜索 仪表盘 ☆☆☆☆☆ ☆☆ ELK：没有云服务日志开箱即用仪表盘。 LTS：提供开箱即用的仪表盘，对常见的云服务日志例如ELB/APIG/DDS/DCS/CFW等提供开箱即用的仪表盘。 日志告警 日志关键词告警和SQL告警 ☆☆☆☆☆ ☆ ELK：没有日志告警功能。 LTS：提供准实时的日志关键词和SQL告警功能。 告警通知渠道（邮件、短信、HTTPS等） ☆☆☆☆☆ ☆ ELK：无法将告警方便地以钉钉、微信、短信等方式通知用户。 LTS：对接华为 云消息 通知服务，能以邮件、短信、微信、钉钉、飞书、HTTP等多种渠道通知客户。 日志转储 转储到对象存储 ☆☆☆☆☆ 无 ELK：无法直接转储对象存储。 LTS：页面简单配置可以将日志转储到对象存储。 日志转储 转储到kafka ☆☆☆☆☆ ☆☆ ELK：需要自己部署程序将日志转发到KAFKA。 LTS：页面简单配置可以将日志实时转储到KAFKA。 日志转储 转储到 数据仓库 ☆☆☆☆☆ 无 ELK：无法直接将日志转储到数据仓库。 LTS：页面简单配置可以将日志转储到数据仓库。 日志加工 定时SQL作业 ☆☆☆☆☆ 无 ELK：没有定时SQL作业能力。 LTS：可以配置定时SQL作业，将原始日志加工统计为想要的少量日志结果。 函数加工 ☆☆☆☆☆ 无 ELK：没有日志加工功能。 LTS：提供函数触发器，在函数服务中可以配置自定义脚本将日志灵活加工。

Web/百度小程序/钉钉小程序/微信小程序/支付宝/快应用SDK上报日志到LTS 使用Web/百度小程序/钉钉小程序/微信小程序/支付宝/快应用SDK上报日志到LTS的场景下，需要开启日志流的匿名写入功能，开启后上报日志没有经过有效鉴权，可能产生脏数据。 登录云日志服务控制台。 在日志管理页面，单击日志组名称对应的。 单击“创建日志流”。 在创建日志流页面，开启“匿名写入”，适用于端侧SDK上报日志，打开匿名写入则表示该日志流打开匿名写入权限，不会经过有效鉴权，可能产生脏数据。 单击“确定”。更多操作请参考管理日志流。 开启“匿名写入”后，就可以使用Web/百度小程序/钉钉小程序/微信小程序/支付宝/快应用SDK上报日志到LTS，详细请参考使用SDK接入LTS。

LTS日志转储状态显示异常是什么原因？ 在云日志服务LTS控制台的“日志转储”页面，日志转储任务的状态显示异常，有可能是如下原因引起： 可能原因：OBS桶策略异常。 解决方法：请您在 对象存储服务 中设置访问控制策略。详细请参考配置桶策略。 可能原因：Kafka集群被删除。 解决方法：请您重新创建Kafka转储配置，详细请参考日志转储至DMS。 可能原因：Kafka的topic被删除。 解决方法：请您重新创建或指定Kafka的topic，详细请参考日志转储至DMS。 父主题： 日志转储

方法2：配置定时任务 登录 DataArts Studio 服务控制台，确保已创建SQ L实例 。 选择实例，单击进入控制台。 在概览页签，单击工作空间下方的数据开发，进入数据开发详情页面。 在作业开发页面，单击新建作业，按照提示填写参数后，单击“确定”。详细操作请参考新建作业。 在已创建成功的作业页面，将 DLI SQL拖动到空白区域。 在空白区域，单击DLI SQL图标，在DLI SQL页面，填写SQL语句“MSCK REPAIR TABLE table_name”，table_name为有分区表的表名称，数据库名称和队列名称选择用户配置转储DLI创建的数据库和队列。 更多DLI SQL属性信息请参考开发SQL脚本。 设置完成DLI SQL属性后，单击空白处，单击“调度配置”，设置定时操作时间，详细操作请参考调度作业。 设置完成后，先单击提交版本，然后单击，作业执行调度触发成功。

如何从第三方云厂商将日志搬迁到华为云LTS? 若用户是在第三方云厂商使用日志服务，有大量数据在第三方云厂商对象存储上，希望将日志搬迁到华为云，对于不同的日志类型，请参考如下方法： 热日志（用于搜索分析）：典型保存7-14天，用于应用运维，该日志不需要搬迁到华为云。用户在华为云直接启用云日志服务LTS，运行14天后，第三方云厂商保存的日志自然就老化了。详细请参考日志管理。 归档日志（用于等保合规）：典型保存180天以上，用于安全合规审计，该日志一般转储存放到对象存储中。使用对象存储的迁移工具，将第三方云厂商保存在对象存储中的文件迁移到华为云对象存储服务OBS即可。详细操作请参考迁移第三方云厂商数据至OBS。 父主题： 产品咨询问题

使用iOS SDK、Android SDK上报日志到LTS 使用iOS SDK、Android SDK上报日志到LTS的场景下，建议您使用AK/SK认证。为了保障安全性，建议您创建一个新的 IAM 用户，并赋予该IAM用户最小权限，参考步骤如下： 登录 统一身份认证 服务控制台。 在用户页面，单击“创建用户”。 在配置用户基本信息页面，访问方式勾选“编程访问”，去掉勾选“管理控制台访问”，凭证类型勾选“访问密钥”，其他参数默认即可。 单击“下一步”，无需加入用户组。 单击“创建用户”，IAM用户创建完成，用户列表中显示新创建的IAM用户。 在“下载访问密钥”对话框，单击“确定”，访问密钥下载成功。更多操作请参考创建IAM用户。 新创建的用户无控制台访问权限，其AK/SK也无云服务的读写权限，只能上报日志到LTS。 使用iOS SDK、Android SDK上报日志到LTS时，您就可以使用获取到AK/SK上报日志了。详细操作请参考使用SDK接入LTS。

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 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服务端返回的详细错误码。 表5 GetObjectOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释： 标识删除的对象是否是删除标记。 LastModified string 参数解释： 对象的最近一次修改时间。 ContentLength string 参数解释： 对象数据的长度。 CacheControl string 参数解释： 响应中的Cache-Control头。 ContentDisposition string 参数解释： 响应中的Content-Disposition头。 ContentEncoding string 参数解释： 响应中的Content-Encoding头 ContentLanguage string 参数解释： 响应中的Content-Language头 ContentType string 参数解释： 对象的MIME类型。 Expires string 参数解释： 响应中的Expires头。 ETag string 参数解释： 对象的ETag值。 VersionId string 参数解释： 对象的版本号。 WebsiteRedirectLocation string 参数解释： 当桶设置了Website配置，该参数指明对象的重定向地址。 StorageClass string 参数解释： 对象的存储类型，当对象存储类型是标准存储时，该值为空。 Restore string 参数解释： 归档存储类别对象的恢复状态。 Expiration string 参数解释： 对象的详细过期信息。 Content string | stream.Readable 参数解释： 对象的内容。当设置了SaveAsFile时该值为空；当设置了SaveAsStream且为true时该值为stream.Readable对象；当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 Metadata object 参数解释： 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 同一个桶中存储的对象名必须是唯一的。 启用服务端加密SSE-C方式时，追加上传和初始化段一样，设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传也必须携带。 启用服务端加密SSE-KMS方式时，有且只有第一次上传且桶内不存在同名对象时，才设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传不携带，会继承之前的设置。 每次追加上传的长度不能超过对象长度上限5G的限制。 每个Appendable对象追加上传次数最多为10000次。 如果对象存储类别为COLD（归档存储）或深度归档存储，则不能调用该接口。 如果桶设置了跨区域复制配置，则不能调用该接口。 并行文件系统不支持追加上传对象。 ObsClient.putObject上传的对象可覆盖ObsClient.appendObject上传的对象，覆盖后对象变为普通对象，不可再进行追加上传。 第一次调用追加上传时，如果已存在同名的普通对象，则会抛出异常（HTTP状态码为409）。 追加上传返回的ETag是当次追加数据内容的ETag，不是完整对象的ETag。

返回结果 表4 返回结果 参数类型 描述 表5 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表5。 表5 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表7 参数解释： 操作成功后的结果数据，详见表7。 约束限制： 当Status大于300时为空。 表6 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服务端返回的详细错误码。 表7 AppendObjectOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 VersionId string 参数解释： 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 ETag string 参数解释： 对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 NextAppendPosition int64 参数解释： 下一次追加上传请求应该提供的追加写位置（position）。 约束限制： 需要追加写的对象首次上传时就必须指定为0，下次追加需要填写的值为服务端本次上传成功返回消息的NextAppendPosition，也可通过ObsClient.getObjectMetadata接口获取NextAppendPosition。 SseKms string 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 SseKmsKey string 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 SseC string 参数解释： 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 SseCKeyMd5 string 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==

请求参数 表1 请求参数列表 参数名称 类型 是否必选 说明 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 约束限制： 无 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 Expires Number 可选 参数解释： 表单上传鉴权的过期时间。 约束限制： 无 取值范围： 正整数。单位：秒。 默认取值： 300 FormParams Object 可选 参数解释： 除key、policy、signature外，表单上传时的其他参数。 约束限制： 无 取值范围： acl cache-control content-type content-disposition content-encoding expires 默认取值： 无

功能说明 基于表单上传是使用HTML表单形式上传对象到指定桶中，对象最大不能超过5GB。 您可以通过ObsClient.createPostSignatureSync生成基于表单上传的请求参数。使用Node.js代码模拟表单上传的完整代码示例，参见post-object-sample。您也可以通过如下步骤进行表单上传： 使用ObsClient.createPostSignatureSync生成用于鉴权的请求参数。 准备表单HTML页面。 将生成的请求参数填入HTML页面。 选择本地文件，进行表单上传。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 创建文件夹本质上来说是创建了一个大小为0且对象名以“/”结尾的对象。

功能说明 您可以根据需要将存储在OBS中的对象下载到本地。如果只需要下载对象的其中一部分数据，可以使用范围下载，下载指定范围的数据。如果指定的下载范围是0~1000，则返回第0到第1000个字节的数据，包括第1000个，共1001字节的数据，即[0， 1000]。如果指定的范围无效，则返回整个对象的数据。可以利用范围下载并发下载大对象，详细代码示例请参考concurrent-download-object-sample。

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。 如果指定的范围无效（比如开始位置、结束位置为负数，大于文件大小），则会返回整个对象。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 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服务端返回的详细错误码。 表5 GetObjectOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释： 标识删除的对象是否是删除标记。 LastModified string 参数解释： 对象的最近一次修改时间。 ContentLength string 参数解释： 对象数据的长度。 CacheControl string 参数解释： 响应中的Cache-Control头。 ContentDisposition string 参数解释： 响应中的Content-Disposition头。 ContentEncoding string 参数解释： 响应中的Content-Encoding头 ContentLanguage string 参数解释： 响应中的Content-Language头 ContentType string 参数解释： 对象的MIME类型。 Expires string 参数解释： 响应中的Expires头。 ETag string 参数解释： 对象的ETag值。 VersionId string 参数解释： 对象的版本号。 WebsiteRedirectLocation string 参数解释： 当桶设置了Website配置，该参数指明对象的重定向地址。 StorageClass string 参数解释： 对象的存储类型，当对象存储类型是标准存储时，该值为空。 Restore string 参数解释： 归档存储类型对象的恢复状态。 Expiration string 参数解释： 对象的详细过期信息。 Content string | stream.Readable 参数解释： 对象的内容。当设置了SaveAsFile时该值为空；当设置了SaveAsStream且为true时该值为stream.Readable对象；当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 Metadata object 参数解释： 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 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服务端返回的详细错误码。 表5 GetBucketQuotaOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 StorageQuota number 参数解释： 桶的配额值。 默认取值： 0，表示没有限制桶配额。

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

接口约束 桶配额值必须为非负整数，单位为字节，支持的最大值为263-1。 桶的拥有者的状态是欠费冻结状态时不可以查询桶配额信息。 您必须是桶拥有者或拥有获取桶配额的权限，才能获取桶配额。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketQuota权限，如果使用桶策略则需授予GetBucketQuota权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

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

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

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult GetBucketMetadataOutput 参数解释： 操作成功后的结果数据，详见GetBucketMetadataOutput。 约束限制： 当Status大于300时为空。 表4 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服务端返回的详细错误码。 表5 GetBucketLocationOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 Location string 参数解释： 桶所在的区域。 约束限制： 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 取值范围： 当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 默认取值： 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。

对象下载简介(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。 OBS Node.js SDK提供了丰富的对象下载接口，可以通过以下方式下载对象： 文本下载(Node.js SDK) 流式下载(Node.js SDK) 文件下载(Node.js SDK) 范围下载(Node.js SDK) 断点续传下载(Node.js SDK) 您可以通过ObsClient.getObject下载对象。 父主题： 下载对象(Node.js SDK)

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

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

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