Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Service Authorization Management/ Querying Cloud Service Access Permissions
Updated on 2024-02-21 GMT+08:00
View PDF

Querying Cloud Service Access Permissions

Function

This API is used to query the cloud service access permissions of a tenant.

URI

GET /v1/{project_id}/access-service

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

access_services

Array of AccessServiceInfo objects

Access service authorization information list.
Table 5 AccessServiceInfo

Parameter

Type

Description

name

String

Name of the access service. Enter a maximum of 20 characters.

description

String

Description of the access service. Enter a maximum of 500 characters.

grant

Boolean

Whether it is authorized or not. The value can be true or false.

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}/access-service

Example Responses

Status code: 200

Response body for querying tenant agreements.

{
  "access_services" : [ {
    "name" : "DLI",
    "description" : "Data Lake Insight",
    "grant" : true
  }, {
    "name" : "DWS",
    "description" : "Data Warehouse Service",
    "grant" : true
  }, {
    "name" : "MA",
    "description" : "ModelArts",
    "grant" : true
  } ]
}

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

Response body for querying tenant agreements.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.