Updated on 2024-02-21 GMT+08:00

Querying an Agency

Function

This API is used to query an agency.

URI

GET /v1/{project_id}/agency

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

agency_type

Yes

String

Agency type. The options are JOB_TRUST (job agency) and ADMIN_TRUST (system agency).

Enumeration values:

  • JOB_TRUST

  • ADMIN_TRUST

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

agency_type

String

Agency type. The options are JOB_TRUST (job agency) and ADMIN_TRUST (system agency).

Enumeration values:

  • JOB_TRUST

  • ADMIN_TRUST

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: 401

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: 403

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: 408

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.

Status code: 500

Table 10 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

/v1/{project_id}/agency?agency_type=JOB_TRUST

Example Responses

Status code: 200

Agency result.

{
  "agency_type" : "JOB_TRUST"
}

Status Codes

Status Code

Description

200

Agency result.

400

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

401

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

403

{ "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" }

404

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

408

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

500

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

Error Codes

See Error Codes.