Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ OBS Management/ Querying the OBS Bucket Objects
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Querying the OBS Bucket Objects

Function

This API is used to query the OBS bucket objects.

URI

GET /v1/{project_id}/obs/buckets/{bucket_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID (lakeformation_04_0026.xml).

bucket_name

Yes

String

OBS bucket name. The value can contain 1 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

marker

No

String

Name of the object from which the query starts. The value should contain a maximum of 4,096 characters.

limit

Yes

Integer

Number of returned records. The value ranges from 1 to 1000.

prefix

No

String

Search prefix. The value should contain a maximum of 4,096 characters.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

object_names

Array of strings

Object name list.

location

String

Region code.

prefix

String

Search prefix.

bucket_name

String

OBS bucket name.

next_marker

String

Start position of the next object.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Example Requests

GET https://{endpoint}/v1/{project_id}/obs/buckets/{bucket_name}

Example Responses

Status code: 200

Response body for querying OBS bucket objects.

{
  "object_names" : [ "aaa/", "test/" ],
  "location" : "xxxxxx",
  "prefix" : "",
  "bucket_name" : "lakeformation",
  "next_marker" : "next"
}

Status code: 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

Response body for querying OBS bucket objects.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: OBS Management