Obtaining Service Access Client Details

Function

This API is used to obtain service access client details by ID.

URI

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

**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.
client_id	Yes	String	Client ID. The value is automatically generated when the client is created.

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 body parameters
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 4** 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/{client_id}

Example Responses

Status code: 200

{
  "id" : "gs23xxxxxxxxxxxxxxxxxxxxxxxxxxxxfgs2",
  "name" : "lakeformation_client",
  "access_mode" : "SYSTEM",
  "status" : "RUNNING",
  "vpc_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e",
  "subnet_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e",
  "access_connections" : [ {
    "vpcep_id" : "0612xxxxxxxxxxxxxxxxxxxxxxxxxxxxa8fb"
  } ],
  "create_time" : "2023-05-30T01:22:44.100Z"
}