Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Service Authorization Management/ Querying the Current System Agreement
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Querying the Current System Agreement

Function

This API is used to query the current system agreement.

URI

GET /v1/{project_id}/agreement-rule

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-request-id

String

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

Parameter

Type

Description

agreement_rules

Array of AgreementRule objects

System agreement list.
Table 5 AgreementRule

Parameter

Type

Description

agreement_name

String

Agreement name.

agreement_display_name

String

Agreement display name.

agreement_version

String

Agreement version

agreement_url

String

Agreement URL.

Status code: 400

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

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

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.

Example Requests

GET https://{endpoint}/v1/{project_id}/agreement-rule

Example Responses

Status code: 200

System agreement response body.

{
  "agreement_rules" : [ {
    "agreement_name" : "agreement AAA",
    "agreement_display_name" : "AAA",
    "agreement_version" : "v1",
    "agreement_url" : "https://AAA"
  }, {
    "agreement_name" : "agreement BBB",
    "agreement_display_name" : "BBB",
    "agreement_version" : "v1",
    "agreement_url" : "https://BBB"
  } ]
}

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

System agreement response body.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.