[comment]: # ({935965bf-0cec15ee})
# 29 URL

[comment]: # ({/935965bf-0cec15ee})

[comment]: # ({44743321-103f7d14})
### 描述

这些参数以及相应仪表板 widget 字段的可能属性值 objects 允许在 `dashboard.create` 和 `dashboard.update` 方法中配置 [*URL*](/manual/web_interface/frontend_sections/dashboards/widgets/url) widget。

::: noteimportant
widget `fields` 属性在仪表板创建或 update 期间不会进行验证。  
这允许用户修改 [built-in widgets](/manual/web_interface/frontend_sections/dashboards/widgets) 和 create [custom widgets](/devel/modules/tutorials/widget)，但也存在创建或更新控件不正确的风险。  
为确保成功创建或 update *URL* 控件，请参考下表中列出的参数行为。
:::

[comment]: # ({/44743321-103f7d14})

[comment]: # ({5944f4ec-df854d95})
### 参数

*URL* 小组件支持以下参数。

| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *Refresh interval* | 0 | rf_rate | 0 - *(默认)* 不刷新；<br>10 - 10 秒；<br>30 - 30 秒；<br>60 - 1 分钟；<br>120 - 2 分钟；<br>600 - 10 分钟；<br>900 - 15 分钟。 |
| *URL* | 1 | url | 有效的 URL string。<br><br>[参数行为](/manual/api/reference_commentary#参数行为)：<br>- *必填* |
| *Override host* | 1 | override_hostid.\_reference | `ABCDE._hostid` - 将一个 [部件兼容性](/manual/web_interface/frontend_sections/dashboards/widgets#部件兼容性)（其 *Reference* 参数设置为 "`ABCDE`"）设置为 主机 的数据源；<br>`DASHBOARD._hostid` - 将仪表板 [覆盖主机](/manual/web_interface/frontend_sections/dashboards/widgets#覆盖主机) 设置为 主机 的数据源。<br><br>如果在 [template dashboard](/manual/api/reference/templatedashboard/object) 上配置小get，则不支持此参数。 |

[comment]: # ({/5944f4ec-df854d95})

[comment]: # ({b34af70f-44ecbf19})
### 示例

以下示例仅用于描述仪表板中*URL*小部件的配置步骤，其中涉及配置仪表板 widget 字段 objects。
有关配置仪表板的更多信息，请参见 [`dashboard.create`](/manual/api/reference/dashboard/create)。

[comment]: # ({/b34af70f-44ecbf19})

[comment]: # ({6aa26102-34af51c0})
#### 配置*URL*部件

配置一个显示Zabbix手册首页的*URL*部件。

[执行请求](/manual/api#执行请求):

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "url",
                        "name": "URL",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "url",
                                "value": "https://www.zabbix.com/documentation/7.0/en"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}
```
响应：

```json
{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}
```

[comment]: # ({/6aa26102-34af51c0})

[comment]: # ({e9d30322-c2753f05})
### 另请参阅

-   [Dashboard widget field](/manual/api/reference/dashboard/object#dashboard-widget-field)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-c2753f05})