获取服务接入客户端信息列表 - ListAccessClientInfos

功能介绍

根据LakeFormation实例获取服务实例相关的接入客户端信息列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目编号。获取方法，请参见获取项目ID 约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
instance_id	是	String	参数解释: LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25 约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及

表2 Query参数
参数	是否必选	参数类型	描述
id	否	String	参数解释: ID搜索。根据ID进行搜索约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
name	否	String	参数解释: 名称关键字搜索。只能包含字母、数字、下划线和中划线，且最大长度为32个字符约束限制: 最大长度为32 取值范围: 最大长度为32 默认取值: 不涉及
offset	是	Integer	参数解释: 分页查询时的偏移量。默认值为0。最小值为0，最大值为1000 约束限制: 取值为0~1000 取值范围: 取值为0~1000 默认取值: 0
limit	否	Integer	参数解释: 分页一页显示数。默认值为10。最小值为1，最大值为1000 约束限制: 取值为1~1000 取值范围: 取值为1~1000 默认取值: 10

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释: 租户token 约束限制: 长度为0~65534个字符取值范围: 长度为0~65534个字符默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
access_client_infos	Array of AccessClientInfo objects	参数解释: 接入客户端信息列表
total	Integer	参数解释: 接入客户端信息总数

表5 AccessClientInfo
参数	参数类型	描述
id	String	参数解释: 客户端ID
name	String	参数解释: 客户端名称
access_mode	String	参数解释: 接入模式：SYSTEM、CUSTOM、AUTO、PROXY
status	String	参数解释：客户端状态取值范围：不涉及 RUNNING：运行中 DELETING：删除中 DELETED：删除完成 CREATE_FAIL：创建失败 DELETE_FAIL：删除失败
vpc_id	String	参数解释: VPC ID
subnet_id	String	参数解释: 子网ID
subnet_ids	Array of strings	参数解释: 多个子网ID集合
access_connections	Array of AccessConnectionInfo objects	参数解释: 接入连接列表
create_time	String	参数解释: 实例创建时间戳

表6 AccessConnectionInfo
参数	参数类型	描述
vpcep_id	String	参数解释: 虚拟私有云终端节点ID。在接入管理-创建客户端-前往VPC创建-VPC终端节点创建和查看
subnet_id	String	参数解释: 子网ID
ip	String	参数解释: 接入IP
owner	String	参数解释: 拥有者
domain	String	参数解释: 接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名

请求示例

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

响应示例

状态码：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" : "example.com"
    }, {
      "vpcep_id" : "0612xxxxxxxxxxxxxxxxxxxxxxxxxxxxa8fb",
      "ip" : "10.1.0.2",
      "domain" : "example.com"
    } ]
  } ]
}

状态码

状态码	描述
200	OK

错误码

请参见错误码。

父主题： 接入管理

上一篇：申请接入服务 - ApplyForAccess

下一篇：创建服务接入客户端 - CreateAccessClient