本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 儀表板 JSON 模型
<a name="dashboard-json-model"></a>

****  
本文件主題專為支援 Grafana **8.x 版的 Grafana** 工作區而設計。  
如需支援 Grafana 12.x 版的 Grafana 工作區，請參閱 [使用 Grafana 第 12 版](using-grafana-v12.md)。  
如需支援 Grafana 10.x 版的 Grafana 工作區，請參閱 [使用 Grafana 第 10 版](using-grafana-v10.md)。  
如需支援 Grafana 9.x 版的 Grafana 工作區，請參閱 [使用 Grafana 第 9 版](using-grafana-v9.md)。

 Amazon Managed Grafana 中的儀表板由 JSON 物件表示，該物件存放其儀表板的中繼資料。儀表板中繼資料包括儀表板屬性、面板中繼資料、範本變數和面板查詢。

**檢視儀表板的 JSON**

1.  開啟儀表板。

1.  在頂端導覽列上，選擇**管理儀表板**上的 。

1.  從下拉式選單中選取**檢視 JSON**。

## JSON 欄位
<a name="dashboard-json-fields"></a>

 當使用者建立新的儀表板時，會使用下列欄位初始化新的儀表板 JSON 物件。

**注意**  
 在下列 JSON 中， `id` 會顯示為 `null`，這是在儲存儀表板之前指派給它的預設值。儲存儀表板後，系統會將整數值指派給 `id` 欄位。

```
{
  "id": null,
  "uid": "cLV5GDCkz",
  "title": "New dashboard",
  "tags": [],
  "style": "dark",
  "timezone": "browser",
  "editable": true,
  "hideControls": false,
  "graphTooltip": 1,
  "panels": [],
  "time": {
    "from": "now-6h",
    "to": "now"
  },
  "timepicker": {
    "time_options": [],
    "refresh_intervals": []
  },
  "templating": {
    "list": []
  },
  "annotations": {
    "list": []
  },
  "refresh": "5s",
  "schemaVersion": 17,
  "version": 0,
  "links": []
}
```

 下表提供儀表板 JSON 中每個欄位的使用詳細資訊。


|  名稱  |  Usage  | 
| --- | --- | 
|  id  |  儀表板的唯一數字識別符 （由資料庫產生）。 | 
|  uid  |  可由任何人產生的唯一儀表板識別符。uid 是 8-40 個字元的字串。 | 
|  標題  |  儀表板的目前標題。 | 
|  tags  |  與儀表板相關聯的標籤。在 JSON 中，標籤是字串陣列。 | 
|  style  |  儀表板的主題 （例如， dark 或 light)。 | 
|  timezone  |  儀表板的時區 (utc 或 browser)。 | 
|  editable  |  是否可以編輯儀表板。 | 
|  graphTooltip  |  工具提示樣式。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/grafana/latest/userguide/dashboard-json-model.html)  | 
|  time  |  儀表板的時間範圍 （例如， 過去 6 小時、過去 7 天）。 | 
|  timepicker  |  Timepicker 中繼資料。如需詳細資訊，請參閱[時間挑選器](#dashboard-json-timepicker)。 | 
|  templating  |  範本中繼資料。如需詳細資訊，請參閱[範本和變數](templates-and-variables.md)。 | 
|  annotations  |  註釋中繼資料。如需詳細資訊，請參閱[註釋](dashboard-annotations.md)。 | 
|  refresh  |  自動重新整理間隔。 | 
|  schemaVersion  |  JSON 結構描述 （整數） 的版本，會在每次 Amazon Managed Grafana 更新變更結構描述時遞增。 | 
|  version  |  儀表板的版本 （整數），會在每次更新儀表板時遞增。 | 
|  panels  |  面板陣列。如需詳細資訊，請參閱[面板](#dashboard-JSON-panels)。 | 

## 面板
<a name="dashboard-JSON-panels"></a>

 面板是儀表板的建置區塊。它包含資料來源查詢、圖形類型、別名和其他資料。面板 JSON 由一組 JSON 物件組成，每個物件代表不同的面板。大多數欄位適用於所有面板，但某些欄位取決於面板類型。下列範例顯示文字面板的面板 JSON。

```
"panels": [
  {
    "type": "text",
    "title": "Panel Title",
    "gridPos": {
      "x": 0,
      "y": 0,
      "w": 12,
      "h": 9
    },
    "id": 4,
    "mode": "markdown",
    "content": "# title"
  }
```

### 面板大小和位置
<a name="panel-size-and-position"></a>

 `gridPos` 屬性說明網格座標中的面板大小和位置：
+  `w` – 1-24。儀表板的寬度分為 24 欄。
+  `h` – 網格高度單位。每個網格高度單位代表 30 像素。
+  `x` – x 位置。x 位置在與 相同的資料欄單位中使用 `w`。
+  `y` – y 位置。y 位置使用與 相同的網格高度單位`h`。

 如果面板上方有空白空間，則網格具有負重力，可將面板向上移動。

### 時間挑選器
<a name="dashboard-json-timepicker"></a>

下列範例顯示 `timepicker`選項。

```
"timepicker": {
    "collapse": false,
    "enable": true,
    "notice": false,
    "now": true,
    "refresh_intervals": [
      "5s",
      "10s",
      "30s",
      "1m",
      "5m",
      "15m",
      "30m",
      "1h",
      "2h",
      "1d"
    ],
    "status": "Stable",
    "type": "timepicker"
  }
```

 下表提供 的使用詳細資訊`timepicker`。


|  名稱  |  Usage  | 
| --- | --- | 
|  collapse  |  timepicker 是否收合  | 
|  enable  |  timepicker 是否已啟用  | 
|  notice  |  TODO  | 
|  now  |  TODO  | 
|  refresh\_intervals  |  TODO  | 
|  status  |  TODO  | 
|  type  |  TODO  | 

### 範本化
<a name="json-templating"></a>

 `templating` 欄位包含具有儲存值和其他中繼資料的範本變數陣列。下列範例顯示`templating`中繼資料。

```
 "templating": {
    "enable": true,
    "list": [
      {
        "allFormat": "wildcard",
        "current": {
          "tags": [],
          "text": "prod",
          "value": "prod"
        },
        "datasource": null,
        "includeAll": true,
        "name": "env",
        "options": [
          {
            "selected": false,
            "text": "All",
            "value": "*"
          },
          {
            "selected": false,
            "text": "stage",
            "value": "stage"
          },
          {
            "selected": false,
            "text": "test",
            "value": "test"
          }
        ],
        "query": "tag_values(cpu.utilization.average,env)",
        "refresh": false,
        "type": "query"
      },
      {
        "allFormat": "wildcard",
        "current": {
          "text": "apache",
          "value": "apache"
        },
        "datasource": null,
        "includeAll": false,
        "multi": false,
        "multiFormat": "glob",
        "name": "app",
        "options": [
          {
            "selected": true,
            "text": "tomcat",
            "value": "tomcat"
          },
          {
            "selected": false,
            "text": "cassandra",
            "value": "cassandra"
          }
        ],
        "query": "tag_values(cpu.utilization.average,app)",
        "refresh": false,
        "regex": "",
        "type": "query"
      }
    ]
  }
```

 下表提供範本區段的用量詳細資訊。


|  名稱  |  Usage  | 
| --- | --- | 
|  啟用  |  是否啟用範本。 | 
|  清單  |  物件陣列，每個代表一個範本變數  | 
|  allFormat  |  從資料來源擷取所有值時要使用的格式 （例如，、regex、 wildcard glob和 pipe)。 | 
|  目前  |  在儀表板上顯示目前選取的變數文字或值  | 
|  資料來源  |  顯示變數的資料來源  | 
|  includeAll  |  是否可使用所有值選項  | 
|  多  |  是否可以從變數值清單中選取多個值  | 
|  multiFormat  |  從資料來源擷取時間序列時要使用的格式  | 
|  name  |  變數的名稱  | 
|  options  |  可用於在儀表板上選取的變數文字/值對陣列  | 
|  query  |  用來擷取變數值的資料來源查詢  | 
|  重新整理  |  TODO  | 
|  regex  |  TODO  | 
|  type  |  變數的類型 (custom、 query或 interval)  |