

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# GetMetricWidgetImage: Struktur dan Sintaks Widget Metrik
<a name="CloudWatch-Metric-Widget-Structure"></a>

`MetricWidget`adalah parameter input untuk [https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html) API. Ini adalah string dalam format JSON. 

**Topics**
+ [Struktur Keseluruhan](#Metric-Widget-Overall-Structure)
+ [Format untuk Setiap Metrik dalam Array Metrik](#CloudWatch-Metric-Widget-Metrics-Array-Format)
+ [Format Properti Anotasi](#CloudWatch-Metric-Widget-Annotations-Format)
+ [Format Properti yAxis](#CloudWatch-Metric-Widget-YAxis-Properties-Format)

## Struktur Keseluruhan
<a name="Metric-Widget-Overall-Structure"></a>

`MetricWidget`String dapat mencakup parameter berikut:

**metrik**  
Metrik untuk disertakan dalam grafik, sebagai `metrics` array. Ini dapat mencakup ekspresi matematika metrik dan metrik mentah. Satu `metrics` array dapat mencakup 1-100 metrik dan ekspresi. Untuk informasi lebih lanjut tentang format `metrics`, lihat [Format untuk Setiap Metrik dalam Array Metrik](#CloudWatch-Metric-Widget-Metrics-Array-Format).  
Jenis: Array array  
Wajib: Ya.

**anotasi**  
Anotasi horizontal dan vertikal untuk ditambahkan ke grafik, sebagai array anotasi. Untuk informasi selengkapnya tentang format, lihat[Format Properti Anotasi](#CloudWatch-Metric-Widget-Annotations-Format).  
Wajib: Tidak

**end**  
Tanggal dan waktu untuk akhir metrik yang ditunjukkan dalam grafik. **Ini dapat dinyatakan sebagai nilai absolut, seperti **2018-04-25 T12:00:00.000Z** atau nilai relatif seperti -PID.**  
Jika Anda tidak menentukan`end`, default `-PT0H` (waktu saat ini) digunakan.  
Tipe: String  
Wajib: Tidak

**tingginya**  
Ketinggian widget dalam piksel. Defaultnya adalah 400.  
Nilai yang Valid: 1—2000  
Jenis: Integer  
Wajib: Tidak, tetapi Anda harus mengatur ini jika Anda juga menetapkan nilai untuk`width`.

**legenda**  
Menentukan lokasi dan visibilitas legenda grafik. `legend`berisi satu bidang,`position`. Nilai dari `position` dapat berupa `bottom`, `right`, atau `hidden`. Default-nya adalah `bottom`.  
Tipe: String  
Wajib: Tidak

**LiveData**  
Tentukan `true` untuk menampilkan *data langsung* di widget. Data langsung adalah data yang diterbitkan dalam menit terakhir yang belum dikumpulkan sepenuhnya. Untuk informasi selengkapnya, lihat [Menggunakan Data Langsung](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-live-data.html).  
Tipe: Boolean  
Wajib: Tidak

**periode**  
Periode default, dalam hitungan detik, untuk semua metrik di widget ini. Default ini dapat diganti dalam setiap definisi metrik. Angka default-nya adalah 300.  
Nilai yang Valid: 1, 5, 10, 30, 60, dan kelipatan 60. 1, 5, 10, dan 30 hanya untuk metrik resolusi tinggi.  
Tipe: Integer  
Wajib: Tidak

**region**  
Parameter ini bersifat opsional. Jika Anda memasukkannya, itu harus menentukan Wilayah lokal.  
Tipe: String  
Wajib: Tidak

**menumpukkan**  
Tentukan `true` untuk menampilkan grafik sebagai garis bertumpuk, atau `false` untuk ditampilkan sebagai garis terpisah. Default-nya adalah salah.  
Tipe: Boolean  
Wajib: Tidak

**start**  
Tanggal dan waktu untuk memulai metrik yang ditunjukkan dalam grafik. **Ini dapat dinyatakan sebagai nilai absolut, seperti **2018-04-25 T12:00:00.000Z** atau nilai relatif seperti -PID.**  
Jika Anda tidak menentukan`start`, default `-PT3H` (tiga jam yang lalu) digunakan.  
Tipe: String  
Wajib: Tidak

**stat**  
Statistik default yang akan ditampilkan untuk setiap metrik dalam array. Default ini dapat diganti dalam definisi masing-masing metrik individu dalam array. `metrics`  
Jika Anda menghilangkan ini, default dari `Average` digunakan.  
Nilai yang valid: `SampleCount` `Average` \| `Sum` \| `Minimum` \| `Maximum` \| `p{{??}}` \| `TC({{??}}:{{??}})` \|`TM({{??}}:{{??}})`, `TS({{??}}:{{??}})` \| `WM({{??}}:{{??}})` \| `PR({{??}}:{{??}})` \| `IQM`  
Jenis: String yang merupakan CloudWatch statistik yang valid.  
Wajib: Tidak

**tema**  
Palet warna yang digunakan untuk menata grafik. Nilai default-nya `light`.  
Nilai Valid: `light | dark`  
Tipe: String  
Wajib: Tidak

**timezone**  
Zona waktu yang digunakan untuk menampilkan waktu dalam grafik. Formatnya adalah \+ atau - diikuti oleh empat digit. Dua digit pertama menunjukkan jumlah jam di depan atau di belakang UTC, dan dua digit terakhir adalah jumlah menit. Misalnya, `+0130` menunjukkan waktu 1 jam dan 30 menit sebelum UTC. Default-nya adalah `+0000`.  
Tipe: String  
Wajib: Tidak

**title**  
Judul yang akan ditampilkan untuk grafik.  
Tipe: String  
Wajib: Tidak

**lihat**  
Format tampilan. Tentukan `timeSeries` untuk menampilkan metrik ini sebagai grafik garis. Tentukan `bar` untuk menampilkan metrik sebagai grafik batang. Tentukan `pie` untuk menampilkan metrik sebagai grafik lingkaran. Nilai default-nya `timeSeries`.  
Nilai Valid: `timeSeries | bar | pie`  
Tipe: String  
Wajib: Tidak

**lebar**  
Lebar widget dalam piksel. Defaultnya adalah 600.  
Nilai yang Valid: 1—2000  
Jenis: Integer  
Wajib: Tidak, tetapi Anda harus mengatur ini jika Anda juga menetapkan nilai untuk`width`.

**yAxis**  
Batas minimum dan maksimum sumbu y. Ini berlaku untuk setiap metrik yang dibuat grafik, kecuali metrik tertentu menimpanya. Untuk informasi selengkapnya tentang format, lihat[Format Properti yAxis](#CloudWatch-Metric-Widget-YAxis-Properties-Format).  
Jenis: objek yAxis  
Wajib: Tidak

## Format untuk Setiap Metrik dalam Array Metrik
<a name="CloudWatch-Metric-Widget-Metrics-Array-Format"></a>

Setiap item dalam `metrics` array adalah CloudWatch metrik untuk ditampilkan dalam grafik, atau untuk digunakan sebagai bagian dari ekspresi matematika yang ditampilkan dalam grafik. Untuk informasi selengkapnya tentang ekspresi matematika, lihat [Menggunakan Matematika Metrik](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html) di Panduan CloudWatch Pengguna Amazon.

Setiap metrik dalam array memiliki format berikut:

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

**Namespace**  
 AWS Namespace yang berisi metrik. Untuk menggunakan namespace yang sama dengan metrik sebelumnya dalam array, Anda dapat menentukan `"."` untuk setiap entri setelah yang pertama.  
Tipe: String  
Diperlukan: Ya

**MetricName**  
Nama CloudWatch metrik. Untuk menggunakan nama yang sama dengan metrik sebelumnya dalam array, Anda dapat menentukan `"."` untuk setiap entri setelah yang pertama.  
Tipe: String  
Diperlukan: Ya

**DimensionName**  
Nama dimensi untuk lebih menyempurnakan data apa yang ditampilkan. Untuk menggunakan nama dimensi yang sama dengan metrik sebelumnya dalam array, Anda dapat menentukan `"."` untuk setiap entri setelah yang pertama. Anda dapat menentukan dimensi nol untuk metrik, atau hingga dimensi sebanyak yang didukung metrik.  
Tipe: String  
Wajib: Tidak

**DimensionValue**  
Nilai yang digunakan untuk dimensi itu untuk metrik. Diperlukan jika ada nama dimensi yang sesuai.  
Tipe: String  
Wajib: Tidak, kecuali ada nama dimensi yang sesuai.

**Pilihan Obyek**  
Menentukan baik properti rendering kustom yang akan digunakan untuk CloudWatch metrik tertentu, atau ekspresi matematika untuk ditampilkan pada grafik. Untuk informasi selengkapnya tentang format, lihat[Pilihan Obyek Format](#CloudWatch-Metric-Widget-Options-Object-Format).   
Jenis: Objek Pilihan  
Wajib: Tidak

*Contoh*

```
// 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" ]
```

### Pilihan Obyek Format
<a name="CloudWatch-Metric-Widget-Options-Object-Format"></a>

Menentukan baik properti rendering kustom yang akan digunakan untuk CloudWatch metrik tertentu, atau ekspresi matematika untuk ditampilkan pada grafik.

Jika objek ini ditentukan sebagai bagian dari CloudWatch metrik dalam `metrics` array, ia menetapkan properti rendering kustom untuk metrik ini dan mengganti default yang digunakan untuk seluruh grafik.

Anda juga dapat menentukan objek ini untuk menambahkan ekspresi matematika ke grafik. Dalam hal ini, pengaturan lain dalam objek ini menentukan opsi tampilan untuk hasil ekspresi matematika.

Bagian ini menjelaskan format objek opsi ini.

**warna**  
Kode warna hex HTML enam digit yang akan digunakan untuk metrik atau ekspresi ini.  
Tipe: String  
Wajib: Tidak

**ekspresi**  
Ekspresi matematika untuk ditampilkan. Untuk informasi selengkapnya tentang fungsi dan format ekspresi matematika yang didukung, lihat [Sintaks dan Fungsi Matematika Metrik](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) di Panduan CloudWatch Pengguna Amazon.  
Jenis: String yang merupakan ekspresi matematika CloudWatch metrik yang valid.  
Wajib: Ya jika ini adalah ekspresi.

**label**  
Label yang akan ditampilkan untuk metrik atau ekspresi ini dalam legenda grafik. Jika ini tidak ditentukan, metrik diberikan label yang dibuat secara otomatis yang membedakannya dari metrik lain di widget.  
Tipe: String  
Wajib: Tidak

**id**  
Pengidentifikasi untuk metrik atau ekspresi ini, yang harus unik dalam widget ini. Id dapat digunakan sebagai variabel untuk mewakili metrik atau ekspresi ini dalam ekspresi matematika. Karakter yang valid adalah huruf, angka, dan garis bawah. Karakter pertama harus berupa huruf kecil.   
Tipe: String  
Wajib: Tidak

**periode**  
Periode untuk metrik ini, dalam hitungan detik. Jika ditentukan, ini akan menggantikan periode default yang digunakan untuk metrik lain dalam grafik ini. Parameter ini tidak berlaku untuk ekspresi matematika.  
Nilai yang Valid: 1, 5, 10, 30, 60, dan kelipatan 60. 1, 5, 10, dan 30 hanya untuk metrik resolusi tinggi.  
Tipe: Integer  
Wajib: Tidak

**stat**  
Statistik yang akan ditampilkan untuk metrik ini, jika ingin berbeda dari statistik yang digunakan untuk metrik lain dalam grafik. Parameter ini tidak berlaku untuk ekspresi matematika.  
Nilai yang Valid: `SampleCount` `Average` `Sum` \| \| `Minimum` \| `Maximum` \| `p{{??}}`  
Jenis: String yang merupakan CloudWatch statistik yang valid.  
Wajib: Tidak

**terlihat**  
Menentukan apakah metrik ini atau ekspresi ditampilkan pada grafik. Nilai default-nya `true`.  
Pengaturan `visible` ke `false` berguna jika Anda ingin menyembunyikan metrik mentah yang digunakan dalam ekspresi matematika, dan hanya menampilkan hasil ekspresi pada grafik.  
Tipe: Boolean  
Wajib: Tidak

**yAxis**  
Dimana pada grafik untuk menampilkan sumbu y untuk metrik atau ekspresi ini. Nilai default-nya `left`.  
Nilai Valid: `left` \| `right`  
Tipe: String  
Wajib: Tidak

*Contoh*

Dalam contoh berikut, CloudWatch mengambil `apiLatency` metrik kustom. Di bagian atas, statistik p50 ditentukan untuk menunjukkan nilai median. Selanjutnya, untuk metrik yang sama pada contoh yang sama (ini ditentukan oleh empat bidang yang hanya periode), nilai Rata-rata dibuat grafik. Berikutnya adalah objek opsi dengan ekspresi matematika, menunjukkan nilai setengah dari dua metrik. Akhirnya, ekspresi lain menunjukkan tingkat perubahan.

Untuk hanya menampilkan hasil dari dua ekspresi pada grafik dan menyembunyikan metrik mentah, Anda dapat mengubah dua contoh pertama dari `visible` ke. `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"
                }
            ]
        ]
    }
```

## Format Properti Anotasi
<a name="CloudWatch-Metric-Widget-Annotations-Format"></a>

Sebuah grafik tunggal dapat memiliki beberapa anotasi horizontal dan vertikal. Semua anotasi horizontal ditentukan dalam satu `horizontal` bidang, dan semua anotasi vertikal ditentukan dalam satu `vertical` bidang.

**horisontal**  
Sebuah array anotasi horisontal. Anotasi horizontal memiliki beberapa opsi untuk bayangan pengisian, termasuk bayangan di atas garis anotasi, bayangan di bawah garis anotasi, dan bayangan “pita” yang muncul di antara dua garis anotasi tertaut sebagai bagian dari satu anotasi. Setiap anotasi horizontal dalam array yang tidak memiliki bayangan pita memiliki format berikut:  

```
{{{value}}, {{label}}, {{color}}, {{fill}}, {{yAxis}}, {{visible}}}
```
Setiap anotasi horizontal yang memiliki bayangan pita memiliki format berikut:  

```
[{{{value}}, {{label}}, {{color}}, {{yAxis}}, {{visible}}}, {{{value}}, {{label}}}]
```

**vertikal**  
Sebuah array anotasi vertikal. Anotasi vertikal memiliki beberapa opsi untuk bayangan pengisian, termasuk bayangan sebelum baris anotasi, bayangan setelah baris anotasi, dan bayangan “pita” yang muncul di antara dua baris anotasi tertaut sebagai bagian dari anotasi pita tunggal. Setiap anotasi vertikal dalam array yang tidak memiliki bayangan pita memiliki format berikut:  

```
{{{value}}, {{label}}, {{color}}, {{fill}}, {{visible}}}
```
Setiap anotasi vertikal yang memiliki bayangan pita memiliki format berikut:  

```
[{{{value}}, {{label}}, {{color}}, {{visible}}}, {{{value}}, {{label}}}]
```

`horizontal`Array dapat mencakup bidang-bidang berikut.

**nilai**  
Nilai metrik dalam grafik tempat garis anotasi horizontal akan muncul. Pada anotasi bayangan pita, dua nilai untuk `Value` menentukan tepi atas dan bawah pita.  
Pada grafik dengan anotasi horizontal, grafik diskalakan sehingga semua anotasi horizontal yang terlihat muncul pada grafik.   
Tipe: Float  
Diperlukan: Ya, jika anotasi horizontal digunakan.

**label**  
String yang muncul pada grafik di sebelah anotasi.  
Tipe: String  
Wajib: Tidak

**warna**  
Kode warna hex HTML enam digit yang akan digunakan untuk anotasi. Warna ini digunakan untuk garis anotasi dan bayangan isian.  
Tipe: String  
Wajib: Tidak

**mengisi**  
Cara menggunakan fill shading dengan anotasi. Nilai yang valid adalah `above` untuk bayangan di atas anotasi, `below` untuk bayangan di bawah anotasi, dan `none` tanpa bayangan. Jika `fill` dihilangkan, tidak ada naungan.  
Pengecualian adalah anotasi dengan bayangan pita. Anotasi ini selalu memiliki bayangan antara dua nilai, dan nilai apa pun untuk diabaikan`fill`.  
Tipe: String  
Wajib: Tidak

**terlihat**  
Setel ini `true` agar anotasi muncul di grafik, atau `false` disembunyikan. Defaultnya adalah `true`.  
Tipe: Boolean  
Wajib: Tidak

**yAxis**  
Jika grafik menyertakan beberapa metrik, tentukan apakah angka dalam `Value` mengacu pada metrik yang terkait dengan kiri Y-axis atau kanan. Y-axis Nilai yang valid adalah `right` dan `left`.  
Tipe: String  
Wajib: Tidak

`vertical`Array dapat mencakup bidang-bidang berikut.

**nilai**  
Cap waktu di mana garis anotasi vertikal akan muncul. Ini harus ditentukan sebagai cap waktu absolut, seperti`2018-08-28T15:25:26Z`. Pada anotasi bayangan pita, dua nilai untuk `Value` menentukan tepi awal dan akhir band.  
Tipe: String  
Wajib: Ya, jika anotasi vertikal digunakan.

**label**  
String deskriptif yang muncul pada grafik di sebelah anotasi.  
Tipe: String  
Wajib: Tidak

**warna**  
Kode warna hex HTML enam digit yang akan digunakan untuk anotasi. Warna ini digunakan untuk garis anotasi dan bayangan isian.  
Tipe: String  
Wajib: Tidak

**mengisi**  
Cara menggunakan fill shading dengan anotasi. Nilai yang valid adalah `before` untuk bayangan sebelum anotasi, `after` untuk bayangan setelah anotasi, dan `none` tanpa bayangan. Jika `fill` dihilangkan, tidak ada naungan.  
Pengecualian adalah anotasi dengan bayangan pita. Anotasi ini selalu memiliki bayangan antara dua nilai, dan nilai apa pun untuk diabaikan`fill`.  
Tipe: String  
Wajib: Tidak

**terlihat**  
Setel ini `true` agar anotasi muncul di grafik, atau `false` disembunyikan. Defaultnya adalah `true`.  
Tipe: Boolean  
Wajib: Tidak

*Contoh*

```
// 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"
            }
        ]
    ]
}
```

## Format Properti yAxis
<a name="CloudWatch-Metric-Widget-YAxis-Properties-Format"></a>

Mendefinisikan nilai minimum dan maksimum untuk grafik. Y-axis Atur ini di dalam `MetricWidget` objek untuk memengaruhi semua metrik di widget. Untuk mengganti pengaturan widget untuk metrik tertentu, atur di objek opsi untuk metrik tersebut dalam `metrics` array.

**kiri**  
Opsional `min` dan `max` pengaturan untuk kiri Y-axis.  
Jenis: objek yAxis  
Wajib: Tidak

**kanan**  
Opsional `min` dan `max` pengaturan untuk kanan Y-axis.  
Jenis: objek yAxis  
Wajib: Tidak

Masing-masing `left` dan `right` objek dapat mencakup parameter berikut:

**min**  
Nilai minimum untuk ini Y-axis.  
tipe: Mengambang  
Wajib: Tidak

**max**  
Nilai maksimum untuk ini Y-axis.  
tipe: Mengambang  
Wajib: Tidak

*Contoh*

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