On this page

Show all

Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Location/ Canceling OBS Path Authorization in Batches from LakeFormation

Canceling OBS Path Authorization in Batches from LakeFormation

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

View PDF

Function

This API cancels the authorization of OBS paths in batches from LakeFormation. Note that the authorization of OBS paths already utilized by metadata cannot be canceled.

URI

POST /v1/cancel-authorize-location

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Tenant token.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
locations	Yes	Array of strings	List of OBS paths whose authorization needs to be canceled.

Response Parameters

Status code: 400

**Table 3** 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 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: 500

**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.

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: 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	Authorization canceled successfully.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
408	Request Timeout
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Location

Previous topic: Querying the List of OBS Paths Authorized to LakeFormation

Next topic: LakeCat

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot