文档首页/ 智能数据湖 AI DataLake/ API参考/ API/ 网络接入客户端管理/ 查询网络接入客户端列表 - ListV2AccessClients
更新时间:2026-11-16 GMT+08:00
分享

查询网络接入客户端列表 - ListV2AccessClients

功能介绍

查询指定workspace下的网络接入客户端列表,支持分页和按名称/ID过滤。此接口为同步接口,无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/access-clients

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释:工作空间ID,可通过查询工作空间列表获取工作空间ID。

约束限制:不涉及。

取值范围:长度为32~36的英文字符、数字和中划线的组合。

默认取值:不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:分页偏移量。

约束限制:不涉及。

取值范围:0~10000。

默认取值:0。

limit

否

Integer

参数解释:分页大小。

约束限制:不涉及。

取值范围:1~1000。

默认取值:100。

name

否

String

参数解释:通过网络接入客户端名称搜索网络接入客户端,支持模糊搜索。

约束限制:不涉及。

取值范围:长度为1~64的英文字符、中文字符、数字、中划线(-)和下划线(_)的组合。

默认取值:不涉及。

id

否

String

参数解释:通过网络接入客户端ID搜索网络接入客户端。

约束限制:不涉及。

取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。

默认取值:不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:用户Token,通过调用获取IAM用户Token接口获取。

约束限制:不涉及。

取值范围:只能由英文字母、数字及特殊字符组成,长度不超过65534个字符。Token格式由IAM服务定义,具体字符集参见IAM服务相关文档。

默认取值:不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:记录总数。

取值范围:0~100。

access_client_infos

Array of V2AccessClientListInfo objects

参数解释:网络接入客户端信息列表。

取值范围:0~100。

表5 V2AccessClientListInfo

参数

参数类型

描述

id

String

参数解释:网络接入客户端ID。

取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。

name

String

参数解释:网络接入客户端名称。

取值范围:长度为1~64的字符。

status

String

参数解释:网络接入客户端状态。

取值范围:

  • CREATING:创建中。

  • RUNNING:运行中。

  • DELETING:删除中。

  • DELETED:已删除。

  • CREATE_FAIL:创建失败。

  • DELETE_FAIL:删除失败。

vpc_id

String

参数解释:虚拟私有云ID。

取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。

subnet_id

String

参数解释:子网ID。

取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。

vpcep_id

String

参数解释:该网络接入客户端创建的VPCEP ID。

取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。

ip

String

参数解释:IP地址。

取值范围:不涉及。

create_time

String

参数解释:创建时间。

取值范围:不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

请求示例

查询指定workspace下的网络接入客户端列表。

GET /v2/workspaces/{workspace_id}/access-clients?offset=0&limit=10

{
  "offset" : 0,
  "limit" : 10
}

响应示例

状态码:200

{
  "total" : 1,
  "access_client_infos" : [ {
    "id" : "f7670aea-36a1-4bdf-ae99-963c33324370",
    "name" : "vpcep-client-001",
    "status" : "RUNNING",
    "vpc_id" : "050e154d-9954-4929-b6d3-12af7c9213ac",
    "subnet_id" : "0d86d58d-d864-47ce-8dbd-5487ff1d59ba",
    "vpcep_id" : "1851896e-3731-4072-8b4a-33e38ed2207b",
    "ip" : "192.168.0.57",
    "create_time" : "2026-09-30T10:00:00.000+00:00"
  } ]
}

状态码:400

{
  "error_code" : "AIDataLake.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码:401

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码:403

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码:404

{
  "error_code" : "AIDataLake.00010009",
  "error_msg" : "No resources found.",
  "solution_msg" : "Ensure the requested resource exists and the parameters are correct."
}

状态码:500

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

500

内部服务器错误。

相关文档