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

Querying the OBS Buckets

Function

This API is used to query the OBS buckets.

URI

GET /v1/{project_id}/obs/buckets

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).
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset of the page-based query. The default value is 0. The value ranges from 1 to 1000.

limit

No

Integer

Number of records displayed on one page. The default value is 1000. The value ranges from 1 to 1000.

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 header parameters

Parameter

Type

Description

X-request-id

String

Request ID, which is used to locate auxiliary information.
Table 5 Response body parameters

Parameter

Type

Description

buckets

Array of BucketDetail objects

OBS bucket list.

total

Integer

Total number of OBS buckets.
Table 6 BucketDetail

Parameter

Type

Description

id

String

OBS bucket ID.

name

String

OBS bucket name.

creation_date

String

OBS bucket creation date.

location

String

Region.

Status code: 400

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.

Status code: 404

Table 8 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 9 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

Example Responses

Status code: 200

OBS bucket list.

{
  "total" : 3,
  "buckets" : [ {
    "id" : "555d9e8999c94705be3d7edb70a3199a",
    "name" : "lakeformation",
    "creation_date" : "2022-06-01T09:32:01.487+00:00",
    "location" : "xxxxxx"
  }, {
    "id" : "555d9e8999c94705be3d7edb70a3199a",
    "name" : "lakeformation-test",
    "creation_date" : "2022-06-07T03:20:39.120+00:00",
    "location" : "xxxxxx"
  }, {
    "id" : "555d9e8999c94705be3d7edb70a3199a",
    "name" : "test-bk",
    "creation_date" : "2022-08-02T09:36:37.193+00:00",
    "location" : "xxxxxx"
  } ]
}

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

OBS bucket list.

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