[comment]: # ({d40444c2-0cec15ee})
# 31 URL

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

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

这些参数及对应仪表板小组件字段objects的可选属性值，允许通过`dashboard.create`和`dashboard.update`方法配置[*URL*](/manual/web_interface/frontend_sections/dashboards/widgets/url)小组件。

::: noteimportant
仪表板创建或update过程中不会验证`fields`小组件的属性。  
这虽然允许用户修改[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)上配置小部件，则不支持此参数. |

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

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

以下示例仅描述*URL*小部件的仪表板小部件字段objects的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。

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

[comment]: # ({9721c686-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.4/en"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}
```
响应:

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

[comment]: # ({/9721c686-34af51c0})

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

-   [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

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