All Documents
Current Document
Content is empty
If you don't find the content you expect, please try another search term
Content is empty
If you don't find the content you expect, please try another search term
Last updated：2026-03-18 14:12:55
Welcome to the Kingsoft Cloud Monitor service. This service provides comprehensive data monitoring for a wide range of cloud products, enabling you to retrieve real-time metrics and precisely manage the health status of your business infrastructure and cloud resources.
This document details the API operations available for interacting with the Cloud Monitor service, including retrieving monitoring data and managing custom metrics. For a high-level overview of all available actions, please refer to the API Overview.
Term | Definition | Description |
|---|---|---|
Namespace | Namespace | A namespace represents a specific category of resources. In Kingsoft Cloud, each cloud product corresponds to a unique namespace (e.g., |
Metric | Metric | A metric is a variable that is monitored over time. Monitoring data consists of the numerical values of this variable recorded at specific intervals.Example: |
The Cloud Monitor API allows you to efficiently query and manage monitoring data through two primary workflows:
To retrieve historical or real-time monitoring data for existing cloud resources, use the GetMonitorData API.
Use Case: Analyzing CPU trends, network traffic, or disk I/O for provisioned instances.
Action: GetMonitorData
To push your own application-specific metrics or business data into the Cloud Monitor system, use the PutMetricData API.
Use Case: Uploading custom business KPIs, application latency, or queue depths.
Action: PutMetricData
The following table lists the supported cloud products and their corresponding Namespace identifiers required for API requests.
Namespace | Product Name |
|---|---|
| Object Storage (KS3) |
| Load Balancer (SLB) |
| Peering Connection |
| Shared Bandwidth |
| NoSQL Database (KTS) |
| MongoDB (MONDB) |
| Bare Metal Server (EPC) |
| Dedicated Host (KDC) |
| CDN |
| Distributed DB (DRDS) |
| Data Transfer (KDTS) |
| RabbitMQ |
| Elasticsearch (KES) |
| Container Instance (KCI) |
| InfluxDB |
| KS3 Accelerate |
| vGPU |
| ClickHouse |
| KMR Cluster |
| Cassandra |
|
Note: Ensure the
Namespaceparameter in your API request matches the identifier exactly (case-sensitive).
When retrieving data via OpenAPI or SDK, you may observe discrepancies compared to the values displayed in the Kingsoft Cloud Console. These differences are expected and stem from the following factors:
Network Traffic: For resources such as KEC, KDC, and GPU:
Console: Displays data in bps (bits per second).
SDK/API: Returns data in Bps (Bytes per second).
Conversion: $1 \text{ Bps} = 8 \text{ bps}$.
The Console and API may utilize different default sampling granularities depending on the time range selected:
Console: Automatically adjusts sampling intervals (e.g., 0.5h, 1 day, 3 days, 1 week) for visualization optimization.
API: Returns raw data points based on the Period parameter specified in your request. Ensure your requested period aligns with your analysis needs.
Cloud Monitor supports three aggregation methods: max, min, and average.
The Console may apply a specific aggregation logic optimized for visual charts.
The API returns data strictly based on the Statistics parameter you provide. Mismatched aggregation types will result in different numerical values.
All input and output timestamps in the OpenAPI and SDK are based on Beijing Time (UTC+8).
They are not in UTC. Please adjust your local time conversion logic accordingly if your application operates in a different time zone.
This section provides a comprehensive list of available API operations categorized by functionality.
These APIs allow you to retrieve monitoring metrics and data for standard Kingsoft Cloud products.
API Name | Description |
|---|---|
ListMetrics | Retrieves a list of available monitoring metrics for a specified namespace and instance ID. |
GetMetricStatistics | Retrieves historical or real-time monitoring data for a specific cloud product metric. |
GetMetricStatisticsBatch | Retrieves monitoring data for multiple metrics or instances in a single request (batch operation). |
DescribeMonitorProductList | Retrieves the list of cloud products supported by the Cloud Monitor service. |
Specific APIs for monitoring containerized environments (e.g., KCE, KCI).
API Name | Description |
|---|---|
ListMetrics | Retrieves a list of available monitoring metrics specifically for container resources. |
GetMetricStatistics | Retrieves statistical data for container-related metrics (e.g., pod CPU, memory usage). |
Note: The original input incorrectly described
ListMetricsin this section as "upload data". It has been corrected to reflect its actual function: listing metrics.)
Manage alerting rules, notification receivers, and contact groups to ensure timely response to infrastructure issues.
API Name | Description |
|---|---|
CreateAlarmPolicy | Creates a new alarm policy with specified thresholds and notification settings. |
ListAlarmPolicy | Retrieves a list of all alarm policies configured under the current account. |
DescribeAlarmPolicy | Retrieves detailed information for a specific alarm policy (excluding associated instance details). |
DescribePolicyObject | Retrieves the list of instances/resources associated with a specific alarm policy. |
DescribeAlarmReceives | Retrieves the list of notification receivers (users/groups) associated with an alarm policy. |
AddAlarmReceives | Adds new notification receivers to an existing alarm policy. |
DeleteAlarmReceives | Removes specified notification receivers from an alarm policy. |
DeleteAlarmPolicy | Deletes a specified alarm policy. |
GetUserGroup | Lists all contact groups configured under the current account. |
GetAlertUser | Retrieves contact information for users within the current account. |
UpdateAlertUserStatus | Enables or disables specific contacts within a contact group. |
Query system events and incident groups generated by the cloud platform.
API Name | Description |
|---|---|
DescribeSysEventGroupList | Retrieves a list of system event groups for the current account. |
DescribeSystemEventAttributes | Retrieves detailed attributes and information for a specific system event. |
Pure Mode
