跳转到主要内容
ZStack
设置/SNMP相关接口

查询SNMP代理

查询SNMP代理

GET/zstack/v1/snmp/agent
GET/zstack/v1/snmp/agent/{uuid}

操作 ID

QuerySnmpAgent

起始版本

4.7.21

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • version
      String必填

      SNMP代理使用协议版本

    • readCommunity
      String必填

      读团体字(version为v2c时使用)

    • userName
      String必填

      用户名(version为v3时使用)

    • authAlgorithm
      String必填

      认证算法

    • authPassword
      String必填

      认证密码

    • privacyAlgorithm
      String必填

      隐私算法

    • privacyPassword
      String必填

      隐私密码

    • port
      int必填

      端口

    • status
      String必填

      SNMP代理是否启用

    • securityLevel
      String必填

      安全等级

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间