# 获取OBS对象列表 - GetObsObjects #### 功能介绍 获取OBS对象列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DAS/doc?api=LogoffBuiltInAccount)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-das/das_01_0130.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | das::showCloudDBAInfo | read | instance | - | - | - | #### URI GET /v3/{project_id}/connections/{connection_id}/obs/objects 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-das/das_01_0036.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | connection_id | 是 | String | **参数解释：** 连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由[创建实例连接](https://support.huaweicloud.com/api-das/das_01_0070.html)创建）。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bucket_name | 是 | String | **参数解释：** OBS桶名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | max_keys | 是 | Integer | **参数解释：** 列举对象的最大数目，返回的对象列表将是按照字典顺序的最多前max_keys个对象。 **约束限制：** 不涉及。 **取值范围：** 1\~1000，当超出范围时，按照默认的1000进行处理。 **默认取值：** 1000 | | marker | 否 | String | **参数解释：** 列举桶内对象列表时，指定一个标识符，作为列举时的起始位置，从该标识符以后按对象名的字典顺序返回对象列表。 **约束限制：** 该字段仅用于非多版本列举。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无。 | | prefix | 否 | String | **参数解释：** 列举桶内对象列表时，指定一个前缀，限定返回的对象名必须带有prefix前缀。 **约束限制：** 满足对象名的格式。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无。 | #### 请求参数 无。 #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bucket_name | String | **参数解释：** OBS桶名。 **取值范围：** 不涉及。 | | marker | String | **参数解释：** 列举桶内对象列表时，指定一个标识符，作为列举时的起始位置，从该标识符以后按对象名的字典顺序返回对象列表。 例如，您拥有以下对象：test/a、test/b、test/c、test/d。如果您将test/b指定为标识符，将返回test/c、test/d两个对象。 **取值范围：** 长度大于0且不超过1024的字符串。 | | next_marker | String | **参数解释：** 如果本次没有返回全部结果，响应请求中将包含此字段，用于标明本次请求列举到的最后一个对象。后续请求可以指定Marker等于该值来列举剩余的对象。 **取值范围：** 字符串，下一次请求起始位置的对象名。 | | truncated | Boolean | **参数解释：** 表明本次请求是否返回了全部结果。 **取值范围：** 不涉及。 | | max_keys | Integer | **参数解释：** 列举对象的最大数目，返回的对象列表将是按照字典顺序的最多前max_keys个对象。 **取值范围：** 1\~1000，当超出范围时默认为1000。 | | prefix | String | **参数解释：** 列举桶内对象列表时，指定一个前缀，限定返回的对象名必须带有prefix前缀。 例如，您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀，将返回以字符串"logs/"开头的三个对象。如果您指定空的前缀且请求中没有其他过滤条件，将返回桶中的所有对象。 **取值范围：** 不涉及。 | | common_prefixes | Array of Strings | **参数解释：** 分组信息。 | | contents | Array of [表4] objects | **参数解释：** 对象的元数据信息。 | #### 请求示例 表4ObsObjectInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | object_key | String | **参数解释：** 对象的名称。 **取值范围：** 不涉及。 | | content_length | Long | **参数解释：** 对象文件的大小。 **取值范围：** 不涉及。 | ``` GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/obs/objects?bucket_name=5257&max_keys=1000 ``` #### 响应示例 **状态码： 200** Success. ``` { "bucket_name": "5257", "marker": "", "truncated": false, "max_keys": 1000, "prefix": "", "common_prefixes": [], "contents": [ { "object_key": "DAS_Imexport_Export_40d349d2b11c444384e0a3960f8651b3_all_sql.zip", "content_length": 314 }, { "object_key": "DAS_Imexport_Export_e8388837919049bf9887167241b56f85_all_sql.zip", "content_length": 3852040027 }, { "object_key": "fullsql_bcfa975193f1402fa11a6d4fd6baf5fbin01_1764576400379.zip", "content_length": 3753 } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-das/das_01_0035.html)。