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

GetMetricWidgetImage：指標小工具結構和語法

MetricWidget 是 https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html API 的輸入參數。它是 JSON 格式的字串。

整體結構

MetricWidget 字串可以包含下列參數：

指標陣列中每個指標的格式

metrics 陣列中的每個項目都是要在圖形中顯示的 CloudWatch 指標，或用作圖形中顯示的數學表達式的一部分。如需數學表達式的詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用指標數學。

陣列中的每個指標都有下列格式：

[Namespace, MetricName, Dimension1Name, Dimension1Value, Dimension2Name, Dimension2Value... 
            {Options Object}]

範例

// The simplest example, a metric with no dimensions
        [ "AWS/EC2", "CPUUtilization" ]
        
 // A metric with a single dimension
        [ "AWS/EC2", "CPUUtilization", "InstanceId", "i-01234567890123456" ]
        
 // A metric with a single dimension and rendering properties
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456", { yAxis: "right"} ]
       
 // The following example graphs the DiskReadBytes metric for three instances.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123" ]

選項物件格式

指定要用於指定 CloudWatch 指標的自訂轉譯屬性，或要在圖形上顯示的數學表達式。

如果此物件指定為metrics陣列中 CloudWatch 指標的一部分，則會為此指標設定自訂轉譯屬性，並覆寫用於整個圖形的預設值。

您也可以指定此物件，將數學表達式新增至圖形。在此情況下，此物件中的其他設定會指定數學表達式結果的顯示選項。

本節說明這些選項物件的格式。

範例

在下列範例中，CloudWatch apiLatency 會擷取自訂指標。在頂端，指定 p50 統計資料以顯示中位數值。接下來，針對相同執行個體上的相同指標 （這由只有句點的四個欄位指定），會繪製平均值圖形。接下來是具有數學表達式的選項物件，顯示兩個指標的中途值。最後，另一個表達式會顯示變更率。

若要僅顯示圖形上兩個表達式的結果並隱藏原始指標，您可以將 的前兩個執行個體變更為 visible false。

{
        "metrics": [
            [
                "MyNamespace", 
                "apiLatency", 
                "InstanceId", 
                "i-0987654321abcdef0", 
                {
                    "id": "m1",
                    "stat": "p50",
                    "label": "Median value",
                    "visible": true,
                    "color": "#dddddd",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                ".", 
                ".", 
                ".", 
                ".", 
                {
                    "id": "m2",
                    "stat": "Average",
                    "label": "Average value",
                    "visible": true,
                    "color": "#cccccc",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                {
                    "expression": "(m1+m2)/2",
                    "id": "e1",
                    "label": "Half way between average and median",
                    "visible": true,
                    "color": "#000000",
                    "yAxis": "left"
                }
            ],
            [
                {
                    "expression": "RATE(e1)",
                    "yAxis": "right",
                    "label": "rate of change of the half way point"
                }
            ]
        ]
    }

註釋屬性格式

單一圖形可以有多個水平和垂直註釋。所有水平註釋都指定在一個horizontal欄位中，而所有垂直註釋都指定在一個vertical欄位中。

horizontal 陣列可以包含下列欄位。

vertical 陣列可以包含下列欄位。

範例

// A single horizontal annotation with fill shading above the annotation line, based on the metric associated with the right Y-axis
                    
"annotations": {
     "horizontal": [
         {
              "visible":true,
              "color":"#9467bd",
              "label":"Critical range",
              "value":20,
              "fill":"above",
              "yAxis":"right"
         }
    ]
}

// A horizontal band annotation. Each value has a label, but other parameters for the band need to be specified only with the first number

"annotations": {
    "horizontal": [
        [
             {
                  "label":"Band top",
                  "value":200,
                  "color":"#9467bd",
                  "visible":true,
                  "yAxis":"right"
              },
              {
                  "value":95.5,
                  "label":"Band bottom"
              }
         ]
     ]
}

// A single vertical annotation with fill shading after the annotation line

"annotations": {
    "vertical": [
        {
            "visible": true,
            "color": "#9467bd",
            "label": "Bug fix deployed",
            "value": "2018-08-28T15:25:26Z",
            "fill": "after"
        }
    ]
}	


// A vertical band annotation. Each annotation line has a label, but other parameters for the band are specified only with the first value

"annotations": {
    "vertical": [
        [
            {
                "label": "Band start",
                "value": "2018-08-27T15:25:26Z",
                "color": "#9467bd",
                "visible": true
            },
            {
                "value": "2018-08-28T15:25:26Z",
                "label": "Band end"
            }
        ]
    ]
}

yAxis 屬性格式

定義圖形 Y 軸的最小值和最大值。在 MetricWidget 物件中將此設定為影響小工具中的所有指標。若要覆寫特定指標的小工具設定，請在metrics陣列中該指標的選項物件中進行設定。

每個 left和 right 物件可以包含下列參數：

範例

{
  left: {
    min: 0,
    max: 100
  },
  right: {
    min: 0
  }
}