View a markdown version of this page

将 GetDashboard 与 Amazon SDK 或 CLI 配合使用 - Amazon CloudWatch
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

将 GetDashboard 与 Amazon SDK 或 CLI 配合使用

以下代码示例演示如何使用 GetDashboard。

操作示例是大型程序的代码摘录，必须在上下文中运行。您可以在以下代码示例中查看此操作的上下文：

.NET
适用于 .NET 的 Amazon SDK (v4)
注意

查看 GitHub，了解更多信息。在 Amazon 代码示例存储库中查找完整示例，了解如何进行设置和运行。

    /// <summary>
    /// Get information on a dashboard.
    /// </summary>
    /// <param name="dashboardName">The name of the dashboard.</param>
    /// <returns>A JSON object with dashboard information.</returns>
    public async Task<string> GetDashboard(string dashboardName)
    {
        var dashboardResponse = await _amazonCloudWatch.GetDashboardAsync(
            new GetDashboardRequest()
            {
                DashboardName = dashboardName
            });

        return dashboardResponse.DashboardBody;
    }

  • 有关 API 详细信息，请参阅《适用于 .NET 的 Amazon SDK API Reference》中的 GetDashboard。

CLI
Amazon CLI

检索有关控制面板的信息

以下 get-dashboard 示例显示了有关指定账户中名为 Dashboard-A 的控制面板的信息。

aws cloudwatch get-dashboard \
    --dashboard-name Dashboard-A

输出：

{
    "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
    "DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}",
    "DashboardName": "Dashboard-A"
}

有关更多信息，请参阅《Amazon CloudWatch 用户指南》中的使用 Amazon CloudWatch 控制面板。

  • 有关 API 详细信息，请参阅《Amazon CLI Command Reference》中的 GetDashboard。

PowerShell
适用于 PowerShell V4 的工具

示例 1：返回指定控制面板的正文 arn。

Get-CWDashboard -DashboardName Dashboard1

输出：

DashboardArn                                          DashboardBody
------------                                          -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...

  • 有关 API 详细信息，请参阅《Amazon Tools for PowerShell Cmdlet Reference (V4)》中的 GetDashboard。

Tools for PowerShell V5

示例 1：返回指定控制面板的正文 arn。

Get-CWDashboard -DashboardName Dashboard1

输出：

DashboardArn                                          DashboardBody
------------                                          -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...

  • 有关 API 详细信息，请参阅《Amazon Tools for PowerShell Cmdlet 参考（V5）》中的 GetInventory。

有关 Amazon SDK 开发人员指南和代码示例的完整列表，请参阅 将 CloudWatch 与 Amazon SDK 结合使用。本主题还包括有关入门的信息以及有关先前的 SDK 版本的详细信息。