Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Access Management/ Obtaining the List of Service Access Clients

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

View PDF

Obtaining the List of Service Access Clients

Function

This API is used to obtain the list of access clients related to a LakeFormation instance by instance name.

URI

GET /v1/{project_id}/instances/{instance_id}/access-clients

**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).
instance_id	Yes	String	LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	String	This API is used to search information by ID.
name	No	String	This API is used to search by keyword. The keyword should contain a maximum of 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed.
offset	Yes	Integer	Offset of the page-based query. The default value is 0. The value ranges from 0 to 1000.
limit	No	Integer	Number of records displayed on one page. The default value is 10. The value ranges from 1 to 1000.

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
access_client_infos	Array of AccessClientInfo objects	Access client information list.
total	Integer	Total number of access clients.

**Table 5** AccessClientInfo
Parameter	Type	Description
id	String	Client ID.
name	String	Client name.
access_mode	String	Access mode. The options are SYSTEM, CUSTOM, or AUTO. Enumeration values: SYSTEM CUSTOM AUTO
status	String	Client status. The options are CREATING, RUNNING, DELETING, DELETED, CREATE_FAIL, and DELETE_FAIL. Enumeration values: CREATING RUNNING DELETING DELETED CREATE_FAIL DELETE_FAIL
vpc_id	String	VPC ID.
subnet_id	String	Subnet ID.
access_connections	Array of AccessConnectionInfo objects	Access connection list.
create_time	String	Timestamp when the instance is created.

**Table 6** AccessConnectionInfo
Parameter	Type	Description
vpcep_id	String	VPC endpoint ID. Click Clients, click Create, and click create one. On the displayed page, click VPC Endpoint to create or check a VPC endpoint.
ip	String	Access IP address.
owner	String	Owner.
domain	String	Access domain name. When accessing LakeFormation APIs using an IP address, you need to add the HOST parameter to the request header and transfer the domain name.

Example Requests

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/access-clients

Example Responses

Status code: 200

{
  "total" : 1,
  "access_client_infos" : [ {
    "id" : "gs23xxxxxxxxxxxxxxxxxxxxxxxxxxxxfgs2",
    "name" : "lakeformation_client",
    "access_mode" : "SYSTEM",
    "vpc_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e",
    "subnet_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e",
    "status" : "RUNNING",
    "access_connections" : [ {
      "vpcep_id" : "0612xxxxxxxxxxxxxxxxxxxxxxxxxxxxa8fb",
      "ip" : "10.1.0.1",
      "domain" : "xxxxxx.com"
    }, {
      "vpcep_id" : "0612xxxxxxxxxxxxxxxxxxxxxxxxxxxxa8fb",
      "ip" : "10.1.0.2",
      "domain" : "xxxxxx.com"
    } ]
  } ]
}