华为云用户手册

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey str 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 content str 或 readable object 可选 参数解释： 待上传对象的内容。 取值范围： 字符串或者可读对象。 说明： 如果content是可读对象（包含“read”属性），则从中读取数据，否则作为字符串处理。 默认取值： 无 metadata dict 可选 参数解释： 待上传对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。 约束限制： 所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。 自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。 自定义元数据key-value对都必须符合US-ASCII标准。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文 经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值： 无 headers PutObjectHeader 可选 参数解释： 上传对象的头域，用于设置对象的基本信息，包括存储类别、冗余策略等。 取值范围： 参考PutObjectHeader。 默认取值： 无 progressCallback callable 可选 参数解释： 获取上传进度的回调函数。 默认取值： 无 说明： 该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒），示例代码参考上传对象-获取上传进度。 上传进度回调功能仅支持流式上传、文件上传、上传段、追加上传和断点续传上传。 autoClose bool 可选 参数解释： 上传完成后，自动关闭数据流。 取值范围： True：自动关闭数据流。 False：不开启自动关闭数据流。 默认取值： True extensionHeaders dict 可选 参数解释： 接口的拓展头域。 取值范围： 参考自定义头域。 默认取值： 无

返回结果 表9 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表10 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表11 GetResult.body GetResult.body类型 说明 PutContentResponse 参数解释： 上传对象响应结果，参考PutContentResponse。 表12 PutContentResponse 参数名称 参数类型 描述 storageClass str 参数解释： 对象的存储类型。 取值范围： 当对象存储类型是标准存储时，该值为空。 可选择的存储类型参见StorageClass。 默认取值： 无 versionId str 参数解释： 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 取值范围： 长度为32的字符串。 默认取值： 无 etag str 参数解释： 对象的etag值，即base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。 约束限制： 当对象是服务端加密的对象时，etag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 sseKms str 参数解释： SSE-KMS方式的算法。 取值范围： kms，即以SSE-KMS方式加密对象。 默认取值： 无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从 数据加密 服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。 取值范围： AES256。 默认取值： 无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值： 无 objectUrl str 参数解释： 对象的全路径。 默认取值： 无

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 单次上传对象大小范围是[0, 5GB]。 如果需要上传超过5GB的大文件，需要通过多段操作来分段上传。

返回结果 表10 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表11 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表12 GetResult.body GetResult.body类型 说明 AppendObjectResponse 参数解释： 追加上传的响应结果，参考AppendObjectResponse。 表13 AppendObjectResponse 参数名称 参数类型 描述 storageClass str 参数解释： 对象的存储类型。 取值范围： 当对象存储类型是标准存储时，该值为空。 可选择的存储类型参见StorageClass。 默认取值： 无 etag str 参数解释： 对象的etag值，即base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。 约束限制： 当对象是服务端加密的对象时，etag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 nextPosition int 参数解释： 下次追加上传的位置。 取值范围： 大于等于0的整型数，单位：字节。 默认取值： 无 sseKms str 参数解释： SSE-KMS方式的算法。 取值范围： kms，即以SSE-KMS方式加密对象。 默认取值： 无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。 取值范围： AES256。 默认取值： 无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值： 无 objectUrl str 参数解释： 对象的全路径。 默认取值： 无

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 用户上传的对象存储在桶中。用户必须对桶有WRITE权限，才可以在桶中上传对象。同一个桶中存储的对象名必须是唯一的。 每次追加上传都会更新该对象的最后修改时间。 服务端加密SSE-C方式，那么追加上传和初始化段一样，设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传也必须携带。 服务端加密SSE-KMS方式，有且只有第一次上传且桶内不存在同名对象时，才设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传不携带。 每次追加上传的长度不能超过对象长度上限5G的限制。 每个Appendable对象追加写次数最多为10000次。 如果对象存储类型为COLD（归档存储）或深度归档存储，则不能调用该接口。 如果桶设置了跨区域复制配置，则不能调用该接口。 并行文件系统不支持追加写对象。

返回结果 表9 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表10 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表11 GetResult.body GetResult.body类型 说明 PutContentResponse 参数解释： 上传对象响应结果，参考PutContentResponse。 默认取值： 无 如果file_path是文件夹，则返回结果为包含一组GetResult的列表。 表12 PutContentResponse 参数名称 参数类型 描述 storageClass str 参数解释： 对象的存储类型。 取值范围： 当对象存储类型是标准存储时，该值为空。 可选择的存储类型参见StorageClass。 默认取值： 无 versionId str 参数解释： 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 取值范围： 长度为32的字符串。 默认取值： 无 etag str 参数解释： 对象的etag值，即base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。 约束限制： 当对象是服务端加密的对象时，etag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 sseKms str 参数解释： SSE-KMS方式的算法。 取值范围： kms，即以SSE-KMS方式加密对象。 默认取值： 无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。 取值范围： AES256。 默认取值： 无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值： 无 objectUrl str 参数解释： 对象的全路径。 默认取值： 无

功能说明 您可以将本地文件直接通过Internet上传至OBS指定的桶中。待上传的文件可以是任何类型：文本文件、图片、视频等。 OBS本身是没有文件夹的概念的，桶中存储的元素只有对象。创建文件夹实际上是创建了一个大小为0且对象名以“/”结尾的对象，这类对象与其他对象无任何差异，可以进行下载、删除等操作，只是OBS控制台会将这类以“/”结尾的对象以文件夹的方式展示。 如果开启了多版本控制，上传对象时，OBS自动为每个对象创建唯一的版本号。上传同名的对象将以不同的版本号同时保存在OBS中。如果未开启多版本控制，向同一个文件夹中上传同名的对象时，新上传的对象将覆盖原有的对象。 调用接口时，支持在extensionHeaders参数中以字典形式传入指定的头域，详情请参见自定义头域(Python SDK)。

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 单次上传对象大小范围是[0, 5GB]。 如果需要上传超过5GB的大文件，需要通过多段操作来分段上传。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey str 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 file_path str 必选 参数解释： 待上传文件或者文件夹的完整路径，如aa/bb.txt，或aa/。 默认取值： 无 说明： 如果file_path是文件夹，则headers中的contentLength，md5和contentType会被忽略。 metadata dict 可选 参数解释： 待上传对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。 约束限制： 所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。 自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。 自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文 经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值： 无 headers PutObjectHeader 可选 参数解释： 上传对象的头域，用于设置对象的基本信息，包括存储类别、冗余策略等。 取值范围： 参考PutObjectHeader。 默认取值： 无 progressCallback callable 可选 参数解释： 获取上传进度的回调函数。 约束限制： 不支持获取上传文件夹的上传进度。 默认取值： 无 说明： 该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒），示例代码参考上传对象-获取上传进度。 上传进度回调功能仅支持流式上传、文件上传、上传段、追加上传和断点续传上传。 extensionHeaders dict 可选 参数解释： 接口的拓展头域。 取值范围： 参考自定义头域。 默认取值： 无

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

返回结果说明 表7 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表8 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

接口约束 您必须拥有obs:bucket:CreateBucket权限，才能创建桶。建议使用IAM进行授权，配置方式详见使用IAM自定义策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 创建桶时，如果初始化客户端使用的终端节点（endPoint）为“obs.myhuaweicloud.com”，则可以不指定桶所在区域（location），系统会自动在华北-北京一（cn-north-1）创建桶；如果初始化客户端使用的终端节点（endPoint）不是obs.myhuaweicloud.com，则必须指定桶所在区域（location），且指定的区域必须与终端节点（endPoint）区域一致，否则会返回状态码400。 比如初始化时使用的终端节点endPoint是obs.cn-north-4.myhuaweicloud.com，那么在创建桶的时候必须指定Location：cn-north-4才会创建成功。 同一账号下，可以创建多个存桶，数量上限是100个（不区分地域），存储桶中的对象数量和大小没有限制。 新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409，表明桶已存在。 用户删除桶后，需要等待30分钟才能创建同名桶和并行文件系统。

返回结果 表9 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表10 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表11 GetResult.body GetResult.body类型 说明 PutContentResponse 参数解释： 上传对象响应结果，参考PutContentResponse。 表12 PutContentResponse 参数名称 参数类型 描述 storageClass str 参数解释： 对象的存储类型。 取值范围： 当对象存储类型是标准存储时，该值为空。 可选择的存储类型参见StorageClass。 默认取值： 无 versionId str 参数解释： 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 取值范围： 长度为32的字符串。 默认取值： 无 etag str 参数解释： 对象的etag值，即base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。 约束限制： 当对象是服务端加密的对象时，etag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 sseKms str 参数解释： SSE-KMS方式的算法。 取值范围： kms，即以SSE-KMS方式加密对象。 默认取值： 无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。 取值范围： AES256。 默认取值： 无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值： 无 objectUrl str 参数解释： 对象的全路径。 默认取值： 无

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 单次上传对象大小范围是[0, 5GB]。 如果需要上传超过5GB的大文件，需要通过多段操作来分段上传。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey str 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 content str 或 readable object 可选 参数解释： 待上传对象的内容。 取值范围： 须知： 使用流式上传时，CONTENT参数必须是包含“READ”属性的可读对象。 上传文件流时，必须以二进制模式（“RB”模式或“RB+”模式）打开文件。 默认取值： 无 metadata dict 可选 参数解释： 待上传对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。 约束限制： 所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。 自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。 自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文 经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值： 无 headers PutObjectHeader 可选 参数解释： 上传对象的头域，用于设置对象的基本信息，包括存储类别、冗余策略等。 取值范围： 参考PutObjectHeader。 默认取值： 无 progressCallback callable 可选 参数解释： 获取上传进度的回调函数。 默认取值： 无 说明： 该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒），示例代码参考上传对象-获取上传进度。 上传进度回调功能仅支持流式上传、文件上传、上传段、追加上传和断点续传上传。 autoClose bool 可选 参数解释： 上传完成后，自动关闭数据流。 取值范围： True：自动关闭数据流。 False：不开启自动关闭数据流。 默认取值： 默认为True。 extensionHeaders dict 可选 参数解释： 接口的拓展头域。 取值范围： 参考自定义头域。 默认取值： 无

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 断点续传上传接口传入的文件大小至少要100K以上。 使用SDK的断点续传接口时，必须开启断点续传选项后才能在进程再次进入时读取上一次上传的进度。

功能说明 对分段上传的封装和加强，解决上传大文件时由于网络不稳定或程序崩溃导致上传失败的问题。其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则返回错误信息提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。

返回结果 表9 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表10 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表11 GetResult.body GetResult.body类型 说明 CompleteMultipartUploadResponse 参数解释： 合并段响应结果，参考CompleteMultipartUploadResponse。 表12 CompleteMultipartUploadResponse 参数名称 参数类型 描述 etag str 参数解释： 合并段后根据各个段的ETag值计算出的结果，是对象内容的唯一标识。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无1 bucket str 参数解释： 合并段所在的桶的桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 key str 参数解释： 合并段后得到的对象名。 对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 location str 参数解释： 合并段后得到的对象的url。 例如：https://example-Bucket.obs.regions.myhuaweicloud.com/example-Object 默认取值： 无 versionId str 参数解释： 合并段后得到的对象版本号。 取值范围： 长度为32的字符串。 默认取值： 无 sseKms str 参数解释： SSE-KMS方式的算法。 取值范围： kms，即以SSE-KMS方式加密对象。 默认取值： 无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。 取值范围： AES256。 默认取值： 无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值： 无 objectUrl str 参数解释： 合并段后得到的对象的全路径。 默认取值： 无 encoding_type str 参数解释： 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。

更新环境变量 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 图3 选择组件 单击“环境变量”模块中的“编辑”，进入“环境变量配置”界面。 选择待操作配置，在“操作”列单击“编辑”，参考表2更新环境变量信息。 表2 环境变量配置 参数 参数说明 类型 支持“手工添加”和“凭据导入”。 变量名称 环境变量的名称，必须唯一。 变量/变量引用 变量的值。 当“类型”选择“凭据导入”时，可在下拉框中选择已创建的凭据配置，具体操作请参考添加凭据配置。 在“操作”列的“保存”，并在“环境变量配置”页面单击“确定”，完成环境变量配置更新。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

添加环境变量 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 图1 选择组件 单击“环境变量”模块中的“编辑”，在右侧页面中单击“新增环境变量”。 参考表1进行参数配置。 表1 环境变量配置 参数 参数说明 类型 支持“手工添加”和“凭据导入”。 变量名称 环境变量的名称，必须唯一。 变量/变量引用 变量的值。 当“类型”选择“凭据导入”时，可在下拉框中选择已创建的凭据配置，具体操作请参考添加凭据配置。 例如，设置“变量名称”为“TZ”，“变量/变量引用”为“Asia/Shanghai”。即当程序代码读取“TZ”环境变量时，获取值为“Asia/Shanghai”。可以查看上海的时区，可以比较当地时间与上海的时差。实际执行效果视代码而定。 图2 环境变量配置 （可选）您还可以通过单击“导入”，导入自定义的环境变量文件。 导入的文件应为字符串形式的键值对映射，一次性最多上传200个环境变量，且仅支持json与yaml格式。例如：{ "key1": "value1", "key2": "value2"... }。 在“操作”列单击“保存”，并在“环境变量配置”页面单击“确定”，完成环境变量配置添加。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

删除环境变量 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 图4 选择组件 单击“环境变量”模块中的“编辑”，进入“环境变量配置”界面。 选择待操作配置，在“操作”列单击“删除”，并在弹框中单击“是”。 图5 删除环境变量 在“环境变量配置”页面单击“确定”，完成环境变量配置删除。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

支持计划是否支持退订，如何退订？ 华为云支持退订支持计划服务，按实际未使用天数比例退还预付基础支持费，但下月初仍会正常结算并划扣当月增量支持费用。 云产品架构咨询、云上保障护航服务（基础版）、可用性检查、资源监控与优化等限额增值服务，是给予客户满足特定购买条件华为云支持计划的一次性特别优惠，一旦享受该优惠，即客户已承诺长期使用，支持计划订单不予中途退订。 如果客户未申请使用任何限额增值服务，则按华为云通用产品退订原则执行，可访问退订规则说明。 父主题： 计费类

支持计划如何计费？ 华为云支持计划以自然月为计量周期，按云服务资源使用量计取支持服务费用。结算时根据云服务用量匹配计费阶梯，用量越大费率越低。 华为云支持计划基础级支持免费提供，其他级别均按云服务消费金额阶梯费率收取服务费，具体费用详情，请参见产品价格详情。您可以支持计划提供的价格计算器，选择您需要的服务规格，来快速计算出购买支持计划的参考价格。 华为云可能酌情调整价目表及收费方式，以华为云服务网站最新公布的产品价格详情为准。 父主题： 计费类

计费项 华为云支持计划按云服务资源使用量计取支持服务费用，云服务资源使用量是一定时期内用户使用华为云服务产生的服务消费金额，包括云服务器、 云存储 、网络带宽、数据库等服务类型，但不包括支持计划、专业服务、云市场等服务。并且不区分现金支付、信用支付、代金券支付等支付形式，均纳入统计。结算时根据云服务用量匹配计费阶梯，用量越大费率越低。 云服务资源用量以折前消费金额（官网价）为计量依据，按实际自然月使用量算。包年和包多月的预付费订购云产品，其资源使用量会被均摊到天，计入自然月月度云服务资源使用量。 具体费用详情，请参见产品价格详情。您可以支持计划提供的价格计算器，选择您需要的服务规格，来快速计算出购买支持计划的参考价格。

升级支持计划 华为云支持提升支持计划级别，如将商业级提升为企业级。升级支持计划涉及补扣差额支持费用。 升级涉及支持费用变化：先计算剩余服务时间新支持计划所需基础支持费用，减去老支持计划结余基础支持费用，则为需要补扣的预付基础支持费。增量支持费于月结时分别划扣老支持计划和新支持计划各对应天数产生的按量费用。 升级涉及云上保障护航服务（基础版）配额调整。举例来说，如客户订购开发者级支持计划1年，服务期内申请升级到企业级支持计划，查看支持计划剩余时长是否超过六个月。如果超过六个月，则可获得限额服务。 支持计划升级不涉及可用性检查、资源监控与优化等限额增值服务配额调整。举例来说，如客户订购开发者级支持计划1年，服务期内申请升级到企业级支持计划，因升级而订购的企业级支持计划不满1年，故无法获得限额增值服务。

产品规格 客户可根据项目预算、自身云技术储备、业务重要性及规模来选择适合自己的支持计划产品： 表1 产品规格 支持级别 关键特性 适用场景 基础级 基本的事件响应时间 个人用户或小型企业简单云部署场景 开发者级 较快的事件响应时间 个人用户或小型企业部署实验、测试环境或非关键生产环境 商业级 最快的事件响应时间，并附赠部分增值服务（包年购买或连续购满一年提供） 中大型企业多种类较大规模云部署场景，要求较高的问题响应速度，业务可用性要求较高 企业级 最快的事件响应时间，配置TAM，并附赠大量增值服务（包年购买提供）、附赠部分增值服务（连续购满半年或一年提供） 大型企业多种类超大规模云部署场景，要求很高的问题响应速度，业务可用性要求高 父主题： 产品介绍

修订记录 发布日期 修订记录 2024-11-25 第八次正式发布。 更新什么是支持计划、产品规格、服务目录、支持方式、支持计划响应SLA、第三方软件支持、云上保障护航服务（基础版）、计费说明章节。 2024-04-18 第七次正式发布。 更新服务范围。 2021-04-27 第六次正式发布。 更新服务目录章节。 新增架构支持章节。 2021-04-02 第五次正式发布。 新增可用性检查章节。 新增资源监控与优化章节。 2020-03-31 第四次正式发布。 新增计费说明。 2019-10-08 第三次正式发布。 服务内容章节结构优化。 2019-09-11 第二次正式发布。 企业服务月报章节新增数据采集说明。 2019-01-31 第一次正式发布。 父主题： 产品介绍

企业服务月报 每个自然月的10日（遇法定节假日顺延相应天数）前向客户的华为云注册邮箱和客户要求的其他邮箱发送上月服务月报。 华为云为企业客户提供的包括云资源运行状态和服务支持的月度总结报告，也会包含依据华为云最佳实践经验给出的优化建议。 月报内容主要包括以下方面内容： 概要 服务总结 资源概况 服务工单 安全防护 优化建议 在一些特殊情况下，可能因数据采集制约导致华为云无法生成和发送月报。例如，尚处于上云POC阶段的部署架构可能变动较大不适宜生成月报；专属云特定部署场景也可能导致工具无法采集到月报数据。 在输出服务月报的过程中，华为云需采集客户的基础设施运维数据。所有数据仅用于制作服务月报，不会用于其他任何目的。数据采集类型和用途说明如表1所示。 表1 数据采集类型说明 数据类型 说明 采集和存储方式 数据用途 服务工单数据 技术类、业务类工单清单。 工单的id、描述、问题级别、创建时间、解决时间等工单信息。 经自动化工具调用工单API查询结果，中途不存储数据，月报结果按照租户隔离存储。 自动化统计分析，生成月报“服务工单”内容。 云服务资源实例数据 客户创建的资源列表，各资源数量。 资源id、名称、状态、规格、创建时间、IP地址、使用量及服务资源相关的基本配置信息。 经自动化工具调用云服务API查询结果，中途不存储数据，月报结果按照租户隔离存储。 自动化统计分析，生成月报“资源概况”内容。 资源负载监控数据 CPU使用率、内存使用率、磁盘使用率、磁盘读写速率、IP出口带宽、IP入口带宽、并发连接数、新建连接数、网络延迟、网络丢包率等资源监控指标。 经自动化工具调用云服务API查询结果，中途不存储数据，月报结果按照租户隔离存储。 自动化统计分析，生成月报“资源概况”内容。 安全配置和监控数据 IAM用户信息、安全组配置、日志审计开关、OBS访问控制策略、安全组配置、DDOS封堵或清洗引流记录、WAF配置及应用攻击记录等。 经自动化工具调用云服务API查询结果，中途不存储数据，月报结果按照租户隔离存储。 自动化统计分析，生成月报“安全防护”内容。 消费数据 客户帐号月度消费详单。 经自动化工具调用运营API查询结果，中途不存储数据，月报结果按照租户隔离存储。 自动化统计分析，生成月报“消费趋势”内容。 父主题： 服务内容

什么是支持计划 支持计划是华为云服务的售后支持产品套餐包，是获取华为云服务技术支持的渠道。服务内容涵盖 华为云产品 使用、基于华为云产品的架构部署等方面的技术支持，支持方式包括工单、热线电话、IM企业群等。支持计划提供基础级、开发者级、商业级、企业级四个支持等级，可满足不同规模和技术能力的客户，客户可根据对响应时间与服务内容的需求灵活选择。 支持计划服务可按包年/包月订购，如果包年订购商业级或连续购满一年商业级或企业级支持计划，或连续购满半年企业级支持计划，还可获赠相关额外服务。通过华为云支持计划，华为云技术人员为客户提供主动、专业的支持服务，帮助客户聚焦基于华为云产品创造业务价值。华为云支持计划服务范围如服务范围所示。 父主题： 产品介绍

服务范围 华为云技术、产品使用咨询。 使用华为云技术、产品过程中的最佳实践。 使用华为云产品过程中的问题定位和故障排除协助。 使用华为云API和SDK过程中的接口咨询和故障排除协助。 使用华为云产品过程中相关的第三方软件配置指导以及故障排除协助。 支持计划服务范围不包含： 代码开发。 云上业务操作及代运维。 不在第三方软件支持中的配置指导以及故障排查。 任何未经认证的IM沟通群及非华为云服务支持企业服务群服务支持。 所有第三方软件的安装、补丁更新、测试、故障诊断、优化等日常运维服务。 父主题： 产品介绍