Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

GetMetricWidgetImage：指标小组件的结构和语法

MetricWidget 是 https://docs.amazonaws.cn/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
  }
}