[comment]: # aside: 1

[comment]: # translation:outdated

[comment]: # ({ee4a2645-28092341})
#   用户宏对象

以下对象均与 `usermacro` 接口相关 。

[comment]: # ({/ee4a2645-28092341})

[comment]: # ({2cec3bc3-e654cd12})
### 全局宏

全局宏对象具有以下属性。

|属性|[类型](/manual/api/reference_commentary#数据类型)|描述|
|--|--|------|
|globalmacroid|ID|全局宏的ID。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *只读*<br>- *必填* 更新操作时|
|macro|string|宏字符串。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *必填* 创建操作时|
|value|string|宏的值。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *只写* 如果 `type` 设置为 "Secret macro"时，则只写<br>- *必填* 创建操作时|
|type|integer|宏的类型。<br><br>可能的值:<br>0 - *(默认)* 文本宏<br>1 - 密文宏<br>2 - 密钥宏|
|description|string|宏描述信息。|

[comment]: # ({/2cec3bc3-e654cd12})

[comment]: # ({7b2b2ada-5a3a9f9f})
### 主机宏

主机宏对象定义一个主机或模板上可用的宏. 它具有以下属性。

|属性|[类型](/manual/api/reference_commentary#数据类型)|描述|
|--|--|------|
|hostmacroid|ID|主机宏的ID。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *只读*<br>- *必填* 更新操作时|
|hostid|ID|宏所属主机的主机ID。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *常量*<br>- *必填* 创建操作时|
|macro|string|宏名。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *必填* 创建操作时|
|value|string|宏值。<br><br>[属性行为](/manual/api/reference_commentary#属性行为):<br>- *只读* 如果 `type` 设置为"Secret macro"，则只读<br>- *必填* 创建操作时|
|type|integer|宏的类型。<br><br>可能的值:<br>0 - *(默认)* 文本宏<br>1 - 密文宏<br>2 - 密钥宏|
|description|string|宏的描述信息。|
|automatic|integer|定义宏是否受发现规则控制。<br><br>可能的值:<br>0 - *(默认)* 宏由用户管理<br>1 - 宏由发现规则管理<br><br>用户不允许创建自动宏。<br>要更新自动宏，必须将其[转换为手动](/manual/api/reference/usermacro/update#更改自动发现规则创建的宏值)。|

[comment]: # ({/7b2b2ada-5a3a9f9f})