# 列举已上传的段(HarmonyOS SDK) #### 功能说明通过分段上传任务的ID，列举指定桶中已上传的段。您可以列出特定多段上传任务或所有正在进行的多段上传任务的分段。列举已上传的段操作将返回您已为特定多段上传任务而上传的段信息。对于每个列举已上传的段请求，OBS将返回有关特定多段上传任务的分段信息，最多为1000个分段。如果多段上传中的段超过1000个，您必须发送一系列列举已上传的段请求以检索所有段。请注意，返回的分段列表不包括已合并的分段。 #### 接口约束 - 您必须是桶拥有者或拥有列举已上传的段的权限，才能列举已上传的段。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:ListMultipartUploadParts权限，如果使用桶策略则需授予ListMultipartUploadParts权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[配置对象策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0075.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 ``` listParts(input: ListPartsInput): Response ``` #### 请求参数表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | [ListPartsInput] | 必选 | **参数解释：** 列举已上传的段接口入参，详见[ListPartsInput]。 | 表2ListPartsInput | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | 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的字符串。 **默认取值：** 无 | | UploadId | string | 必选 | **参数解释：** 分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8。 **取值范围：** 长度大于0且不超过32的字符串。 **默认取值：** 无 | | PartNumberMarker | number | 可选 | **参数解释：** 列举已上传段的起始位置。 **约束限制：** 只有PartNumber数目大于该参数的Part会被列出。 **默认取值：** 无 | | MaxParts | number | 可选 | **参数解释：** 列举已上传段的返回结果最大段数目，即分页时每一页中段数目。 **约束限制：** 如果该参数超出1000时，则按照默认的1000进行处理。 **取值范围：** 范围是\[1，1000\] **默认取值：** 1000 | | EncodingType | string | 可选 | **参数解释：** 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 **取值范围：** 可选值为url。 **默认取值：** 无，不设置则不编码。 | #### 返回结果表3返回结果 | **参数类型** | **描述** | |:---|:---| | [Response] 说明：该接口返回一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[Response]。 | 表4Response | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | CommonMsg | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。 | | InterfaceResult | [ListPartsOutput] | **参数解释：** 操作成功后的结果数据，详见[ListPartsOutput]。 **约束限制：** 当Status大于300时为空。 | 表5ICommonMsg | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | Status | number | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 | | Code | string | **参数解释：** OBS服务端返回的错误码。 | | Message | string | **参数解释：** OBS服务端返回的错误描述。 | | HostId | string | **参数解释：** OBS服务端返回的请求服务端ID。 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 | | Id2 | string | **参数解释：** OBS服务端返回的请求ID2。 | | Indicator | string | **参数解释：** OBS服务端返回的详细错误码。 | 表6ListPartsOutput | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **默认取值：** 无 | | 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的字符串。 **默认取值：** 无 | | UploadId | string | **参数解释：** 分段上传任务的ID。例如：000001648453845DBB78F2340DD460D8。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | Initiator | [Initiator] | **参数解释：** 分段上传任务的创建者，详见[Initiator]。 | | Owner | [Owner] | **参数解释：** 和initiator相同，代表分段上传任务的创建者，详见[Owner]。 | | StorageClass | [StorageClassType] | **参数解释：** 待合并对象的存储类型。 **取值范围：** 存储类型取值参见[StorageClassType]。 **默认取值：** 无 | | PartNumberMarker | number | **参数解释：** 列举段的起始位置，与请求中的该参数对应。 **取值范围：** 非负整数。 **默认取值：** 无 | | NextPartNumberMarker | number | **参数解释：** 下次列举段请求的起始位置。如果本次没有返回全部结果，响应请求中将包含此字段，用于标明接下来请求的PartNumberMarker值。 **取值范围：** 非负整数。 **默认取值：** 无 | | MaxParts | number | **参数解释：** 列举段的返回结果最大段数目，与请求中的该参数对应。列举已上传段的返回结果最大段数目，即分页时每一页中段数目。 **约束限制：** 如果该参数超出取值范围时，按照默认的1000进行处理。 **取值范围：** 范围是\[1，1000\]的非负整数。 **默认取值：** 1000 | | IsTruncated | boolean | **参数解释：** 表明本次请求是否返回了全部结果。 **取值范围：** - true：表示没有返回全部结果。 - false：表示已返回了全部结果。 **默认取值：** 无 | | Parts | [Part]\[\] | **参数解释：** 已上传段信息列表，详见[Part]。 | | EncodingType | string | **参数解释：** 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 **取值范围：** 可选值为url。 **默认取值：** 无，不设置则不编码。 | 表7Initiator | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | ID | string | 作为请求参数时必选 | **参数解释：** 创建者的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html) **默认取值：** 无 | | DisplayName | string | 可选 | **参数解释：** 创建者账号名。 **约束限制：** 账号名不支持中文，只能包含英文字母、数字或特殊字符"-_"，且须以字母开头，账号名长度支持6\~32个字符。 **默认取值：** 无 | 表8Owner | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | ID | string | 作为请求参数时必选 | **参数解释：** 所有者的账号ID，即domain_id。 **取值范围：** 如何获取账号ID请参见[如何获取账号ID和用户ID？(HarmonyOS SDK)](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0605.html) **默认取值：** 无 | | DisplayName | string | 可选 | **参数解释：** 所有者的账号用户名。 **默认取值：** 无 | 表9StorageClassType | **常量名** | **原始值** | **说明** | |:---|:---|:---| | STANDARD | STANDARD | 标准存储。标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | WARM | WARM | 低频访问存储。低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | COLD | COLD | 归档存储。归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储。适用于长期不访问（平均几年访问一次）数据的业务场景。 | 表10Part | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | PartNumber | number | **参数解释：** 段号。 **取值范围：** \[1,10000\]的非负整数。 **默认取值：** 无 | | LastModified | string | **参数解释：** 目标段的最近一次修改时间（UTC时间）。 **约束限制：** 日期格式必须为ISO8601的格式。例如：2018-01-01T00:00:00.000Z，表示最后一次修改时间为2018-01-01T00:00:00.000Z。 **默认取值：** 无 | | ETag | string | **参数解释：** 段的ETag值。分段的base64编码的128位MD5摘要。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | Size | number | **参数解释：** 段占用的空间大小。 **取值范围：** 0\~（2^63^-1），单位：字节。 | #### 代码示例本示例用于列举指定uploadId多段任务中已上传的段。 ``` // 引入依赖包 import ObsClient, { ListPartsInput } from '@obs/esdk-obs-harmony'; import { process } from '@kit.ArkTS'; import { BusinessError } from '@kit.BasicServicesKit'; import { hilog } from '@kit.PerformanceAnalysisKit'; const processManager = new process.ProcessManager(); // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"), SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"), // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入 // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"), // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function listParts() { try { const params: ListPartsInput = { // 指定存储桶名称 Bucket: "examplebucket", // 指定对象，此处以 example/objectname 为例 Key: "example/objectname", // 指定多段上传任务号，此处以 00000188677110424014075CC4A77xxx 为例 UploadId: "00000188677110424014075CC4A77xxx", // 指定返回的最大对象数，此处以 100 为例 MaxParts: 100, }; // 列举已上传的段 const result = await obsClient.listParts(params); if (result.CommonMsg.Status < 300) { hilog.info(0x0001, 'OBS-Harmony', "List part successful with bucket(%s) and object(%s)!", params.Bucket, params.Key); hilog.info(0x0001, 'OBS-Harmony', 'RequestId: %s', result.CommonMsg.RequestId); hilog.info(0x0001, 'OBS-Harmony', 'Bucket: %s', result.InterfaceResult.Bucket); hilog.info(0x0001, 'OBS-Harmony', 'Key: %s', result.InterfaceResult.Key); hilog.info(0x0001, 'OBS-Harmony', 'UploadId: %s', result.InterfaceResult.UploadId); hilog.info(0x0001, 'OBS-Harmony', 'PartNumberMarker: %s', result.InterfaceResult.PartNumberMarker); hilog.info(0x0001, 'OBS-Harmony', 'NextPartNumberMarker: %s', result.InterfaceResult.NextPartNumberMarker); hilog.info(0x0001, 'OBS-Harmony', 'MaxParts: %s', result.InterfaceResult.MaxParts); hilog.info(0x0001, 'OBS-Harmony', 'IsTruncated: %s', result.InterfaceResult.IsTruncated); hilog.info(0x0001, 'OBS-Harmony', 'StorageClass: %s', result.InterfaceResult.StorageClass); hilog.info(0x0001, 'OBS-Harmony', 'Initiator.ID: %s', result.InterfaceResult.Initiator.ID); hilog.info(0x0001, 'OBS-Harmony', 'Owner.ID: %s', result.InterfaceResult.Owner.ID); for (let i = 0; i < result.InterfaceResult.Parts.length; i++) { const part = result.InterfaceResult.Parts[i]; hilog.info(0x0001, 'OBS-Harmony', "Part[%d]-ETag:%s, PartNumber:%d, LastModified:%s, Size:%d", i, part.ETag, part.PartNumber, part.LastModified, part.Size); } return; } hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response."); hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status); hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code); hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message); hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId); } catch (error) { hilog.info(0x0001, 'OBS-Harmony', "An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network."); hilog.info(0x0001, 'OBS-Harmony', error); } } listParts(); ``` #### 相关链接 - 关于分段上传-列举已上传的段的API说明，请参见[列举已上传的段](https://support.huaweicloud.com/api-obs/obs_04_0101.html)。 - 分段上传过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。