Help Center/ SparkRTC/ API Reference/ OBS Bucket Management/ Querying the Object List in an OBS Bucket

Updated on 2025-02-08 GMT+08:00

View PDF

Querying the Object List in an OBS Bucket

This interface is used to query objects in an OBS bucket.

GET /v2/rtc-ops/buckets/objects

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
bucket	Yes	String	Specifies the name of the bucket to be queried.
prefix	No	String	Object name prefix, which can be regarded as the folder path.
type	Yes	String	Query type. The options are as follows: folders objects
location	Yes	String	Run the following command to query the region where the bucket is located: cn-north-4 cn-north-1 cn-north-5 cn-north-6 cn-south-1 cn-east-2

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-Id	String	This field carries the request ID for task tracing.

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number of objects.
objects	Array of ObsObject objects	OBS file.

**Table 5** ObsObject
Parameter	Type	Description
file_name	String	Object name.
size	Integer	File size, in unit of KB.
last_modified	String	Last modification time, for example, 2020/07/16 15:11:55 GMT+08:00.

Status code: 401

**Table 6** Response header parameters
Parameter	Type	Description
X-request-Id	String	This field carries the request ID for task tracing.

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 404

**Table 8** Response header parameters
Parameter	Type	Description
X-request-Id	String	This field carries the request ID for task tracing.

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 500

**Table 10** Response header parameters
Parameter	Type	Description
X-request-Id	String	This field carries the request ID for task tracing.

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

None

Status code: 200

Objects in the OBS bucket are successfully queried.

{
  "count" : 1,
  "objects" : [ {
    "file_name" : "test file"
  }, {
    "size" : 7254700
  }, {
    "last_modified" : "20230815085859"
  } ]
}

Status code: 401

The request fails because the X-Auth-Token is incorrect.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 404

Query failed. The task ID does not exist.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 500

Query failed. Server error.

{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}

Status Code	Description
200	Objects in the OBS bucket are successfully queried.
401	The request fails because the X-Auth-Token is incorrect.
404	Query failed. The task ID does not exist.
500	Query failed. Server error.