[comment]: # aside: 1
[comment]: # translation:outdated
[comment]: # ({94e18e5a-7ed888d2})
# 主机接口对象
以下对象与 `hostinterface` API 直接相关。
[comment]: # ({/94e18e5a-7ed888d2})
[comment]: # ({d7e031b4-ce77a3b0})
### 主机接口
主机接口对象具有以下属性
::: noteimportant
注意 `ip` 和 `dns` 属性都是创建操作所*必须*的。
如果不想使用 DNS，请将其设置为空字符串。
:::
|属性|[类型](/manual/api/reference_commentary#data_types)|说明|
|--|--|------|
|interfaceid|ID|接口的 ID。
[属性行为](/manual/api/reference_commentary#property-behavior):
- *只读*
- 更新操作所*必须*的|
|available|integer|主机接口的可用性。
可能的值：
0 - *(默认)* 未知;
1 - 可用;
2 - 不可用.
[属性行为](/manual/api/reference_commentary#property-behavior):
- *只读*|
|hostid|ID|接口所属主机的 ID。
[属性行为](/manual/api/reference_commentary#property-behavior):
- *常数*
- 创建操作所*必须*的|
|type|integer|接口类型。
可能的值：
1 - Agent;
2 - SNMP;
3 - IPMI;
4 - JMX.
[属性行为](/manual/api/reference_commentary#property-behavior):
- 创建操作所*必须*的|
|ip|string|接口使用的 IP 地址。
如果通过 DNS 连接，可以为空。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 创建操作所*必须*的|
|dns|string|接口使用的 DNS 名称。
如果通过 IP 连接，可以为空。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 创建操作所*必须*的|
|port|string|接口使用的端口号。
可包含用户宏。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 创建操作所*必须*的|
|useip|integer|是否应通过 IP 进行连接.
可能的值：
0 - 使用主机 DNS 名称连接；
1 - 使用主机 IP 地址连接。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 创建操作所*必须*的|
|main|integer|接口是否被主机用作默认设置。一台主机上只能有一个某种类型的接口被设置为默认设置。
可能的值：
0 - 不默认；
1 - 默认。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 创建操作所*必须*的|
|details|array|接口的附加 [详细信息](#details) 对象。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 如果 `type` 被设置成 "SNMP" 则是*必须*的|
|disable\_until|timestamp|不可用主机接口的下一次轮询时间。
[属性行为](/manual/api/reference_commentary#property-behavior):
- *只读*|
|error|string|主机接口不可用时的错误文本。
[属性行为](/manual/api/reference_commentary#property-behavior):
- *只读*|
|errors\_from|timestamp|主机接口不可用的时间。
[属性行为](/manual/api/reference_commentary#property-behavior):
- *只读*|
[comment]: # ({/d7e031b4-ce77a3b0})
[comment]: # ({2a505928-3bb71fcc})
### 详细信息
详细信息对象具有以下属性。
|属性|[类型](/manual/api/reference_commentary#data_types)|说明|
|--|--|------|
|version|integer|SNMP 接口版本。
可能的值：
1 - SNMPv1;
2 - SNMPv2c;
3 - SNMPv3.
[属性行为](/manual/api/reference_commentary#property-behavior):
- *必须*|
|bulk|integer|是否使用批量 SNMP 请求。
可能的值：
0 - 不要使用批量请求；
1 - (默认) - 使用批量请求。|
|community|string|SNMP 社区。仅用于 SNMPv1 和 SNMPv2 接口。
[属性行为](/manual/api/reference_commentary#property-behavior):
- 如果 `version` 被设置成 "SNMPv1" 或 "SNMPv2c" 则是*必须*的|
|max_repetitions|integer|[本地 SNMP 批量请求](#native-snmp-bulk-requests) 的最大重复值 (GetBulkRequest-PDUs).
仅用于 SNMPv2 和 v3 中的 `discovery[]` 和 `walk[]` 监控项。
默认： 10.|
|securityname|string|SNMPv3 安全名称。仅用于 SNMPv3 接口。|
|securitylevel|integer|SNMPv3 安全级别。仅用于 SNMPv3 接口。
可能的值：
0 - (默认) - noAuthNoPriv;
1 - authNoPriv;
2 - authPriv.|
|authpassphrase|string|SNMPv3 验证口令。仅用于 SNMPv3 接口。|
|privpassphrase|string|SNMPv3 隐私口令。仅用于 SNMPv3 接口。|
|authprotocol|integer|SNMPv3 验证协议。仅用于 SNMPv3 接口。
可能的值：
0 - (默认) - MD5;
1 - SHA1;
2 - SHA224;
3 - SHA256;
4 - SHA384;
5 - SHA512.|
|privprotocol|integer|SNMPv3 隐私协议。仅用于 SNMPv3 接口。
可能的值：
0 - (默认) - DES;
1 - AES128;
2 - AES192;
3 - AES256;
4 - AES192C;
5 - AES256C.|
|contextname|string|SNMPv3 上下文名称。仅用于 SNMPv3 接口。|
[comment]: # ({/2a505928-3bb71fcc})