Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Location/ Querying the List of OBS Paths Authorized to LakeFormation
Updated on 2025-02-14 GMT+08:00

Querying the List of OBS Paths Authorized to LakeFormation

Function

Querying the list of OBS paths authorized to LakeFormation.

URI

GET /v1/authorize-location

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

location

No

String

OBS path. Fuzzy search is supported.

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 100. The value ranges from 1 to 1000.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Tenant token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

locations

Array of strings

OBS path list.

total

Integer

Total number of OBS paths.

Status code: 400

Table 4 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 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: 500

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.

Example Requests

None

Example Responses

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: 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 of the authorized OBS path.

400

Bad Request

401

Unauthorized

403

Forbidden

404

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

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.