跳转到主要内容
API Explorer|API Explorer
系统管理/系统设置相关接口/SNMP相关接口
GETSNMP起始版本 4.10.0同步需要认证

查询SNMP代理

查询SNMP代理

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • versionString必填

      SNMP代理使用协议版本

    • readCommunityString必填

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

    • userNameString必填

      用户名(version为v3时使用)

    • authAlgorithmString必填

      认证算法

    • authPasswordString必填

      认证密码

    • privacyAlgorithmString必填

      隐私算法

    • privacyPasswordString必填

      隐私密码

    • portint必填

      端口

    • statusString必填

      SNMP代理是否启用

    • securityLevelString必填

      安全等级

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

GET/zstack/v1/snmp/agent

/zstack/v1/snmp/agent

操作 ID

QuerySnmpAgent

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/snmp/agent' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "f0ef8d847b573c6b86565e1d9111723b", "version": "v3", "userName": "zstack", "authAlgorithm": "SHA512", "authPassword": "auth_password", "privacyAlgorithm": "DES", "privacyPassword": "priv_password", "port": 161, "status": "Enable", "securityLevel": "authPriv" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史