创建SNMP代理

POST/zstack/v1/snmp/agent

操作 ID

CreateSnmpAgent

起始版本

4.10.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

params
Object必填
请求体参数结构
- version
  String必填
  SNMP代理使用协议版本
- readCommunity
  String
  读团体字(version为v2c时使用)
- userName
  String
  用户名(version为v3时使用)
- authAlgorithm
  String
  认证算法
- authPassword
  String
  认证密码
- privacyAlgorithm
  String
  隐私算法
- privacyPassword
  String
  隐私密码
- port
  int必填
  端口
- resourceUuid
  String
  资源UUID
- tagUuids
  List
  标签UUID列表
systemTags
List
系统标签
userTags
List
用户标签

响应状态

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
inventory
SnmpAgentInventory必填
详情参考inventory
- 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必填
  最后一次修改时间

变更历史

此 API 暂无变更历史记录。

查看全部变更历史

请求示例

curl -X POST '{host}/zstack/v1/snmp/agent' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "version": "{version}",
    "readCommunity": "{readCommunity}",
    "userName": "{userName}",
    "authAlgorithm": "{authAlgorithm}",
    "authPassword": "{authPassword}",
    "privacyAlgorithm": "{privacyAlgorithm}",
    "privacyPassword": "{privacyPassword}",
    "port": "{port}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ]
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

响应示例

{
  "inventory": {
    "uuid": "6dac2a94d44c3216acc13286a50416aa",
    "version": "v3",
    "userName": "zstack",
    "authAlgorithm": "SHA512",
    "authPassword": "auth_password",
    "privacyAlgorithm": "DES",
    "privacyPassword": "priv_password",
    "port": 161,
    "status": "Enable",
    "securityLevel": "authPriv"
  }
}

数据中心相关接口

集群相关接口

主机相关接口

主机硬件设备相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

Kernel适配器相关接口

镜像存储相关接口

镜像相关接口

本地镜像仓库相关接口

分布式镜像仓库相关接口

虚拟机相关接口

密钥提供程序相关接口

vTPM相关接口

裸金属模板相关接口

裸金属集群相关接口

裸金属设备相关接口

裸金属主机相关接口

裸金属网络相关接口

数据存储相关接口

本地存储相关接口

NFS存储相关接口

分布式存储相关接口

SAN存储相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

分布式交换机相关接口

分布式端口组相关接口

网络服务

安全组相关接口

管理节点监控相关接口

动态资源调度策略相关接口

虚拟机调度策略相关接口

高可用策略相关接口

快照相关接口

备份管理相关接口

CBT相关接口

监控报警相关接口

通知服务相关接口

容量管理相关接口

时序数据(Metric)

任务

事件(Event)

报警器(Alarm)

事件订阅(Event Subscription)

报警文本模板(Text Template)

审计

标签相关接口

自定义属性相关接口

迁移服务相关接口

用户配置相关接口

统一认证服务器相关接口

控制台代理相关接口

AccessKey管理相关接口

IP黑白名单相关接口

安全设置相关接口

日志服务器相关接口

SNMP相关接口

时间管理相关接口

系统参数相关接口

资源高级设置相关接口

进度条相关接口

查询可用资源相关接口

垃圾回收相关接口

许可证相关接口

长时任务相关接口

错误码相关接口

搜索相关接口

认证信息

请求参数

请求体字段

响应状态

变更历史