> 主机接口对象
以下对象与hostinterfaceAPI直接相关。
主机接口
主机接口对象具有以下属性。
<note important>请注意，IP和DNS都是必需的。如果您不想使用DNS，请将其设置为空字符串。 :::
| 属性 [ | 型](/zh/manual/api/reference_commentary#data_types) 描述 | |
|---|---|---|
| interfaceid | 字符串 *( | 读)* 接口ID。 |
| dns (必选) |
字符 接 |
使用的DNS名称。 如果通过IP连接，可以设置为空。 |
| hostid (必选) |
字符 接 | 归属的主机ID。 |
| ip (必选) |
字符 接 |
使用的IP地址。 如果通过DNS域名连接，可以设置为空。 |
| main (必选) |
整数 该 |
口是否在主机上用作默认接口。主机上只能有一种类型的接口作为默认设置。 可能的值： 0 - 不是默认； 1 - 默认。 |
| port (必选) |
字符 接 | 使用的端口号，可以包含用户宏。 |
| type (必选) |
整数 接 |
类型。 可能的值： 1 - agent； 2 - SNMP； 3 - IPMI； 4 - JMX。 |
| useip (必选) |
整数 是 |
应通过IP进行连接。 可能的值： 0 - 使用主机DNS名称连接； 1 - 使用该主机接口的主机IP地址进行连接。 |
| details | array | Additional object for interface. Required if interface 'type' is SNMP. |
详情标签
详情（details）对象具有以下属性。
| 属性 [ | 型](/zh/manual/api/reference_commentary#data_types) 描述 | |
|---|---|---|
| version | 整数 S | MP接口版本。 可能的值： 1 - SNMPv1； 2 - (默认) - SNMPv2c； 3 - SNMPv3 |
| bulk | 整数 是 | 使用批量SNMP请求。 可能的值： 0 - 不使用批量SNMP请求； 1 - (默认) - 使用批量SNMP请求。 |
| community | 字符串 SN | P community。仅由SNMPv1和SNMPv2接口使用。 |
| securityname | 字符串 SN | Pv3安全名称。仅由SNMPv3接口使用。 |
| securitylevel | 整数 S | MPv3安全级别。仅由SNMPv3接口使用。 可能的值： 0 - (默认) - noAuthNoPriv； 1 - authNoPriv； 2 - authPriv。 |
| authpassphrase | 字符串 SN | Pv3认证密码。仅由SNMPv3接口使用。 |
| privpassphrase | 字符串 SN | Pv3私有密码。仅由SNMPv3接口使用。 |
| authprotocol | 整数 S | MPv3身份验证协议。仅由SNMPv3接口使用。 可能的值： 0 - (默认) - MD5； 1 - SHA。 |
| privprotocol | 整数 S | MPv3隐私协议。仅由SNMPv3接口使用。 可能的值： 0 - (默认) - DES； 1 - AES。 |
| contextname | 字符串 SN | Pv3上下文名称。仅由SNMPv3接口使用。 |