文档中心

云监控 API参考手册

最近更新时间：2023-04-16 17:00:00

1 云监控

1.1 查询监控产品列表

1.1.1 使用说明

查询监控产品列表。
GET https://{Endpoint}/cloudmonitor/v1.0/products

1.1.2 请求参数

表1-1 写入 URL 的请求参数

1.1.3 返回数据

表1-2 ProductMeta 字段说明

1.1.4 示例

1. 请求示例
GET https://{Endpoint}/cloudmonitor/v1.0/products
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
     "TotalCount": 14,
     "PageSize": 10,
     "PageNumber": 1,
     "ProductList": [
     {
         "ProductName": "云服务器 ECS",
         "Description": "ecs",
         "ProductCode": "ecs",
         "MonitorType": "云产品监控"
     },
     {
         "ProductName": "弹性公网 IP",
         "Description": "eip",
         "ProductCode": "eip",
         "MonitorType": "云产品监控"
     },
     {
         "ProductName": "负载均衡 SLB",
         "Description": "slb",
         "ProductCode": "slb",
         "MonitorType": "云产品监控"
     }
     ]
}

1.2 查询产品监控项列表

1.2.1 使用说明

查询产品监控项列表，获取具体的监控项。
GET https://{Endpoint}/cloudmonitor/v1.0/products/{ProductCode}/metrics

1.2.2 请求参数

表1-3 Url 参数

表1-4 Query 参数

1.2.3 返回数据

表1-5 MetricMeta

表1-6 PeriodsSt

1.2.4 示例

1. 请求样例
GET https://{Endpoint}/cloudmonitor/v1.0/products/ecs/metrics
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "",
     "TotalCount": 29,
     "PageSize": 10,
     "PageNumber": 1,
     "Metrics": [
     {
         "Name": "CPU 使用率",
         "Unit": "%",
         "ProductCode": "ecs",
         "MetricCode": "ecs_cpu_usage",
         "Period": [
             5,
             15,
             30,
             60,
             3600
         ],
         "Periods": [
         {
             "Period": 5,
             "StatType": "AVG,MIN,MAX"
         },
         {
             "Period": 15,
             "StatType": "AVG,MIN,MAX"
         },
         {
             "Period": 30,
             "StatType": "AVG,MIN,MAX"
         },
         {
             "Period": 60,
             "StatType": "AVG,MIN,MAX"
         },
         {
             "Period": 3600,
             "StatType": "AVG,MIN,MAX"
         }
         ],
         "Description": "",
         "Dimensions": "instance"
         }
         ],
         "Description": "",
         "Dimensions": "instance,device"
     }
     ]
}

1.3 查询监控数据列表

1.3.1 使用说明

查询监控数据列表信息。
GET https://{Endpoint}/cloudmonitor/v1.0/resources/{ResourceId}/metrics/{MetricCode}/datas

1.3.2 请求参数

表1-7 header 参数

表1-8 URL 参数

表1-9 Query 参数

1.3.3 返回数据

表1-10 Point

1.3.4 示例

1. 请求样例
GET https://{Endpoint}/cloudmonitor/v1.0/resources/ecs�pribdnviuegdgp/metrics/ecs_cpu_usage/datasStartTime=1661413811&EndTime=1661417411&
Step=60
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "1",
     "MetricCode": "ecs_cpu_usage",
     "ProductCode": "ecs",
     "Times": [
         1661413811,
         1661414411,
         1661415011,
         1661415611,
         1661416211,
         1661416811,
         1661417411
     ],
     "StartTime": "2022-08-25 15:50:11",
     "EndTime": "2022-08-25 16:50:11",
     "Step": 600,
     "Dimension": "instance",
     "Points": [
     {
         "Name": "ecs-pribdnviuegdgp",
         "Values": [
             "0.39",
             "0.47",
             "0.35",
             "0.53",
             "0.49",
             "0.47",
             "0.43"
         ]
     }
     ]
}

1.4 查询监控数据

1.4.1 使用说明

查询监控项数据。
GET https://{Endpoint}/cloudmonitor /v1.0/resources/{ResourceId}/metrics/{MetricCode}/data

1.4.2 请求参数

表1-11 header 参数

表1-12 URL 参数

1.4.3 返回数据

表1-13 Point

1.4.4 示例

1. 请求样例
GET https://{Endpoint}/cloudmonitor/v1.0/resources/ecs�pribdnviuegdgp/metrics/ecs_cpu_usage/data
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "1",
     "MetricCode": "ecs_cpu_usage",
     "ProductCode": "ecs",
     "Dimension": "instance",
     "CurrentTime": "2022-08-25 16:20:29",
     "Points": [
     {
         "Name": "ecs-pribdnviuegdgp",
         "Value": "0.39"
     }
     ]
}

1.5 查询实例列表

1.5.1 使用说明

查询监控产品实例列表信息。
GET https://{Endpoint}/cloudmonitor/v1.0/{ProductCode}/resources

1.5.2 请求参数

表1-14 header 参数

表1-15 url 参数

表1-16 Query 参数

1.5.3 返回数据

表1-17 ResourceInfo

1.5.4 示例

1. 请求样例
GET https://{Endpoint}/cloudmonitor/v1.0/ecs/resources?PageNumber=1&PageSize=10
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "",
     "TotalCount": 1,
     "PageSize": 10,
     "PageNumber": 1,
     "Resources": [
     {
         "ResourceId": "ecs-pr8no5v5xs6mof",
         "ResourceName": "cecloud-ecs-71345"
     }
     ]
}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服