获取服务接入客户端信息列表
功能介绍
根据LakeFormation实例获取服务实例相关的接入客户端信息列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances/{instance_id}/access-clients
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
instance_id |
是 |
String |
LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
id |
否 |
String |
ID搜索。根据ID进行搜索。 |
name |
否 |
String |
名称关键字搜索。只能包含字母、数字、下划线和中划线，且最大长度为32个字符。 |
offset |
是 |
Integer |
分页查询时的偏移量。默认值为0。最小值为0，最大值为1000。 |
limit |
否 |
Integer |
分页一页显示数。默认值为10。最小值为1，最大值为1000。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
租户token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
access_client_infos |
Array of AccessClientInfo objects |
接入客户端信息列表。 |
total |
Integer |
接入客户端信息总数。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
客户端ID。 |
name |
String |
客户端名称。 |
access_mode |
String |
接入模式：YSTEM、CUSTOM、AUTO。 枚举值：
|
status |
String |
客户端状态：CREATING、RUNNING、DELETING、DELETED、CREATE_FAIL、DELETE_FAIL。 枚举值：
|
vpc_id |
String |
VPC ID。 |
subnet_id |
String |
子网ID。 |
access_connections |
Array of AccessConnectionInfo objects |
接入连接列表。 |
create_time |
String |
实例创建时间戳。 |
请求示例
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/access-clients
响应示例
状态码： 200
OK
{
"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"
} ]
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
