Integration overview
Beyond the console, Cloud Monitor supports OpenAPI debugging, the Alibaba Cloud SDK, and CLI, and Terraform. Choose the Cloud Monitor integration that fits your needs.
OpenAPI
The OpenAPI Portal provides API search, documentation, online debugging, SDK downloads, code samples, error diagnostics, and call statistics for Alibaba Cloud services. It also generates SDK sample code to help you get started. What is OpenAPI?
Version
Alibaba Cloud uses version numbers to manage API lists. Cloud Monitor uses API version 2019-01-01. The string 2019-01-01 is a version identifier, not a date — it always provides the latest API data.
Version | Description |
Recommended |
Online debugging
Cloud Monitor supports API debugging in the OpenAPI Portal. Before calling an API, confirm the service version, endpoint, and integration method.
In the OpenAPI Portal, select the Cloud Monitor CreateMonitorGroup operation. Set the region to China (Hangzhou), specify GroupName (for example, ECS_Group) and ContactGroups (for example, ECS_Alert_Group, obtained from the DescribeContactGroupList response), then click Send Request.
Debugging page
To debug an API, go to the Cloud Monitor API debugging list.
Endpoints
Select the endpoint for your resource region to minimize latency. For example, the public endpoint for Cloud Monitor in the China (Zhangjiakou) region is metrics.cn-zhangjiakou.aliyuncs.com, and the VPC endpoint is metrics-vpc.cn-zhangjiakou.aliyuncs.com.
Public endpoints are globally accessible.
VPC endpoints are accessible only from a VPC in the same region.
High security: accessible only from within a VPC.
Lower latency: internal network avoids public network latency and bandwidth limits.
Lower costs: internal network traffic.
For all regional endpoints, see Endpoints.
User identities
The OpenAPI Portal uses your Alibaba Cloud account by default. Because the root account has full API access, using it for routine operations poses a security risk. For improved security, create a RAM user for API access and daily O&M, and grant only the permissions required to manage Cloud Monitor resources. Grant permissions to a RAM user.
Identity | Supported |
Yes | |
RAM user (Recommended) | Yes |
RAM role (Recommended) | Yes |
More information
Integration methods
Using an SDK is the easiest and most supported way to call OpenAPI operations.
Integration methods
Method | Supported |
Alibaba Cloud SDK (Recommended) | Yes |
Yes | |
Yes | |
No | |
Yes |
Alibaba Cloud SDK
Alibaba Cloud provides SDKs for Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. SDKs handle request signing, timeouts, retries, and response marshalling. Alibaba Cloud SDK.
Call Cloud Monitor API operations using the Cloud Monitor SDK, which lists supported languages and dependencies.
Alibaba Cloud CLI
Alibaba Cloud CLI is a command-line tool built on OpenAPI for managing Alibaba Cloud services. What is Alibaba Cloud CLI?
Alibaba Cloud CLI can call Cloud Monitor API operations. CLI integration examples.
Terraform
Terraform is an open-source tool for provisioning and managing cloud infrastructure through templates. See What is Terraform?
Terraform supports a range of Cloud Monitor resources and data sources.
Get started with Use Terraform to create an alert contact.
Resource Orchestration Service (ROS)
Resource Orchestration Service (ROS) automates cloud resource deployment through templates. See What is Resource Orchestration Service?
You cannot use ROS to call Cloud Monitor API operations.
Direct HTTP calls
Direct HTTP calls require you to implement request signing and construct requests manually, as described in Cloud Monitor API overview and V3 request body and signature mechanism.
Notes
If an API call returns an error, verify the request parameters against the returned error code.
You can also record the request ID or SDK error message from the response and use the Alibaba Cloud OpenAPI Diagnostic Platform to diagnose the issue.
FAQs
Cloud Monitor provides infrastructure monitoring, public network quality monitoring, and business monitoring based on events, custom metrics, and logs. What is Cloud Monitor?
SDKs are available for Java, C#, Go, Python, TypeScript, PHP, and C++. SDK Reference.