跳转到主要内容
ZStack
近期删除/近期删除

查询代理列表

列表已注册代理可选过滤类型状态区域平台。

GET/api/v1/agents

操作 ID

ListAgents

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • type
    String

    类型。

  • status
    String

    状态信息。

  • platformId
    String

    平台ID。

  • region
    String

    区域。

  • limit
    Integer

    最多返回的记录数。

    示例： 0

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • items
    List

    条目列表。

    示例： (nested array)

    • uuid
      String

      资源的UUID，唯一标识该资源。

      示例： agent-abc123-def456

    • name
      String

      资源名称。

      示例： prod-agent-01

    • type
      String

      类型。

      示例： log

    • version
      String

      版本号。

      示例： 1.2.3

    • status
      String

      状态信息。

      示例： online

    • endpoint
      String

      接收端地址。

      示例： http://192.168.1.10:7890

    • platformId
      String

      平台ID。

      示例： plat-001-abc

    • region
      String

      区域。

      示例： us-east-1

    • labels
      String

      标签列表。

      示例： {"env":"prod","team":"ops"}

    • lastHeartbeatAt
      String

      最近一次心跳时间。

      示例： 2026-01-15T08:00:00Z

    • createDate
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • lastOpDate
      String

      最近一次操作时间。

      示例： 2026-01-15T08:00:00Z

  • total
    Integer

    返回结果总数。

    示例： 100

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20