- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- Overview
- Permissions Management
-
Cloud Resource Monitoring
- Resource Groups
-
Server Monitoring
- Overview
- Cloud Eye Plug-in (Agent)
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Viewing Server Monitoring Details
- Cloud Service Monitoring
- Task Center
- Visualization (Dashboards)
-
Alarm Management
- Overview
- Alarm Rules
- Alarm Records
-
Alarm Templates
- Viewing Alarm Templates
- Creating a Custom Template or Custom Event Template
- Modifying a Custom Template or Custom Event Template
- Deleting a Custom Template or Custom Event Template
- Copying a Custom Template or Custom Event Template
- Associating a Custom Template with a Resource Group
- Importing and Exporting Custom Template or Custom Event Templates
- Alarm Notifications
- Example: Creating an Alarm Rule to Monitor ECS CPU Usage
- One-Click Monitoring
- Alarm Masking
- Event Monitoring
- Access Center
- Data Dump
- Quotas and Audit
- Cloud Product Metrics
- Change History
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
API V1
- API Version Management
- Metrics
-
Alarm Rules
- Querying Alarm Rules
- Querying Details of an Alarm Rule
- Enabling or Disabling an Alarm Rule
- Deleting an Alarm Rule
- Creating an Alarm Rule
- Creating a Custom Alarm Template
- Deleting a Custom Alarm Template
- Querying the Alarm History of an Alarm Rule
- Querying Custom Alarm Templates
- Updating a Custom Alarm Template
- Modifying an Alarm Rule
- Monitoring Data
- Quotas
- Resource Groups
- Event Monitoring
-
API V2
- Alarm Rules
- Resources in an Alarm Rule
- Alarm Policies
- Alarm Notifications
- Alarm Records
- Alarm Templates
- Alarm Rules Associated with an Alarm Template
- Resource Groups
- Resources in a Resource Group
-
One-Click Monitoring
- Enabling One-Click Monitoring
- Querying Services and Resources That Support One-Click Monitoring
- Querying Alarm Rules of One Service in One-Click Monitoring
- Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring
- Batch Disabling One-Click Motoring
- Batch Modifying Alarm Notifications in Alarm Rules for One Service That Has One-Click Monitoring Enabled
- Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service That Has One-Click Monitoring Enabled
-
Alarm Notification Masking
- Creating Alarm Notification Masking Rules in Batches
- Modifying the Masking Time of Alarm Notification Masking Rules in Batches
- Modifying an Alarm Notification Masking Rule
- Deleting Alarm Notification Masking Rules in Batches
- Querying Alarm Notification Masking Rules
- Querying Resources for Which Alarm Notifications Have Been Masked
- Dashboards
- Graphs
- Resource Tags
- Metric Management
- API V3
-
Permissions Policies and Supported Actions
- Introduction
- Supported Actions of the API Version Management APIs
- Supported Actions of the Metric Management API
- Supported Actions of the Alarm Rule Management APIs
- Supported Actions of the Monitoring Data Management APIs
- Supported Actions of the Quota Management API
- Supported Actions of the Event Monitoring API
- Common Parameters
- Appendix
- Change History
- SDK Reference
-
FAQs
-
General Consulting
- What Is Rollup?
- How Long Is Metric Data Retained?
- How Many Rollup Methods Does Cloud Eye Support?
- How Can I Export Collected Data?
- What Should I Do If I See Garbled Chinese Characters in an Exported CSV File?
- Why Can't a User of an Enterprise Project View the One-Click Monitoring Function?
- Why Can't a User of an Enterprise Project Select All Resources When Configuring Alarm Rules?
-
Server Monitoring
-
Agent Installation
- How Do I Configure DNS and Security Groups?
- How Do I Configure an Agency?
- How Does the Cloud Eye Agent Obtain a Temporary AK/SK by Authorization?
- What OSs Does the Agent Support?
- Resource Usage and Circuit Breaker Pattern of Agent
- What Should I Do If the Monitoring Is Periodically Interrupted or the Agent Status Keeps Changing?
- What Should I Do If a Service Port Is Used by the Agent?
- Troubleshooting Agent One-Click Restoration Failures
- No Monitoring Data Is Displayed After One-Click Restoration Performed for the Agent
- Does the Server Monitoring Agent Affect Server Performance?
- Troubleshooting the Problem of Reported Metrics Being Discarded
- Metrics
-
Agent Statuses
- How Can I Quickly Restore Agent Configurations?
- What Should I Do If the Agent Status Is Faulty?
- What Should I Do If the Agent Status Is Stopped?
- What Should I Do If the Agent Status Is Running But There Is No Monitoring Data?
- What Can I Do If No Monitoring Data Is Displayed After One-Click Agent Restoration? (Old Agent)
- How Can I Enable the OS Monitoring for a New ECS?
- Agent Status Description and Troubleshooting Methods
- How Do I Obtain Debug Logs of the Agent?
-
Agent Installation
-
Alarm Notifications or False Alarms
- What Is an Alarm Notification? How Many Types of Alarm Notifications Are There? How Can I Configure an Alarm Notification?
- What Alarm Status Does Cloud Eye Support?
- What Alarm Severities Does Cloud Eye Support?
- When Will an "Insufficient data" Alarm Be Triggered?
- How Do I Monitor and View the Disk Usage?
- How Can I Change the Phone Number and Email Address for Receiving Alarm Notifications?
- How Can a User Account Receive Alarm Notifications?
- Why Did I Receive a Bandwidth Overflow Notification While There Being No Bandwidth Overflow Record in the Monitoring Data?
-
Monitored Data Exceptions
- Why Is the Monitoring Data Not Displayed on the Cloud Eye Console?
- Why I Cannot See the Monitoring Data on the Cloud Eye Console After Purchasing Cloud Service Resources?
- Why Doesn't the Cloud Eye Console Display the OS Monitoring Data or Why Isn't the Data Displayed Immediately After the Agent Is Installed and Configured on an ECS?
- Why Is Basic Monitoring Data Inconsistent with Data Monitored by the OS?
- Why Are the Network Traffic Metric Values in Cloud Eye Different from Those Detected in ECS?
- Why Is the Metric Collection Point Lost During Certain Periods of Time?
- Why Are the Four Metrics Memory Usage, Disk Usage, Inband Incoming Rate, and Inband Outgoing Rate Not Displayed for an ECS?
- What Are the Impacts on ECS Metrics If UVP VMTools Is Not Installed on ECSs?
- Why Are the Inbound Bandwidth and Outbound Bandwidth Negative?
- Metric Descriptions
-
User Permissions
- What Should I Do If the IAM Account Permissions Are Abnormal?
- What Can I Do If the System Displays a Message Indicating Insufficient Permissions When I Access Cloud Eye?
- What Can I Do If the System Displays a Message Indicating Insufficient Permissions When I Click Configure on the Server Monitoring Page?
-
General Consulting
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Product Introduction
- Getting Started
- Dashboards
- Resource Groups
- Using the Alarm Function
-
Server Monitoring
- Introduction to Server Monitoring
- Agent Installation and Configuration
- Agent Features per Version
- Installing and Configuring the Agent on a Linux ECS or BMS
- Installing and Configuring the Agent on a Windows ECS
- Installing the Agents in Batches on Linux ECSs
- Managing the Agent
- Installing the Direct Connect Metric Collection Plug-ins
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Custom Monitoring
- Event Monitoring
- Task Center
- Data Dump
- Cloud Service Monitoring
- Auditing Operation Records on Cloud Eye
- Permissions Management
- Quota Adjustment
- Services Interconnected with Cloud Eye
-
FAQs
-
General Consulting
- What Is Rollup?
- How Long Is Metric Data Retained?
- How Many Rollup Methods Does Cloud Eye Support?
- How Can I Export Collected Data?
- Which Services Does Cloud Eye Support Permission- and Region-based Monitoring in the Enterprise Project Dimension?
- Which Cloud Eye Resources Support the Enterprise Project Feature?
- Why Can a User of an Enterprise Project View the Resource Information of the Account on the Overview Page?
-
Server Monitoring
- How Can I Quickly Restore the Agent Configuration?
- How Can I Make a Newly Purchased ECS Monitor Its OS?
- Why Is a BMS with the Agent Installed Displayed in the ECS List on the Server Monitoring Page?
- What OSs Does the Agent Support?
- What Statuses Does the Agent Have?
- What Should I Do If the Monitoring Period Is Interrupted or the Agent Status Keeps Changing?
- What Should I Do If the Service Port Is Used by the Agent?
- How Can I Create an Agency?
- What Can't I Create Another Agency?
- What Should I Do If Agency CESAgentAutoConfigAgency Failed to Be Automatically Created?
- What Can I Do If Agency CESAgentAutoConfigAgency Is Invalid?
- Will the Agent Affect the Server Performance?
- What Should I Do If the Agent Status Is Faulty?
- What Should I Do If the Agent Status Is Stopped?
- What Should I Do If the Agent Status Is Running But There Is No Monitoring Data?
- How Do I Troubleshoot the Agent One-Click Restoration Failure?
- What Can I Do If No Monitoring Data Is Displayed After One-Click Agent Restoration?
-
Alarm Notifications or False Alarms
- What Is an Alarm Notification? How Many Types of Alarm Notifications Are There?
- What Alarm Status Does Cloud Eye Support?
- What Alarm Severities Does Cloud Eye Support?
- When Will an "Insufficient data" Alarm Be Triggered?
- How Do I Monitor and View the Disk Usage?
- How Can I Change the Mobile Number and Email Address for Receiving Alarm Notifications?
- How Can an IAM User Receive Alarm Notifications?
- Why Did I Receive a Bandwidth Overflow Notification While There Being No Bandwidth Overflow Record in the Monitoring Data?
-
Monitored Data Exceptions
- Why Is the Monitoring Data Not Displayed on the Cloud Eye Console?
- Why I Cannot See the Monitoring Data on the Cloud Eye Console After Purchasing Cloud Service Resources?
- Why Is OS Monitoring Data Not Displayed or Not Displayed Immediately After the Agent Is Installed and Configured on a server?
- Why Is Basic Monitoring Data Inconsistent with the Data Monitored by the OS?
- Why Are the Network Traffic Metric Values in Cloud Eye Different from Those Detected in ECS?
- Why Is the Metric Collection Point Lost During a Certain Period of Time?
- Why Are Memory Usage, Disk Usage, Inband Incoming Rate, and Inband Outgoing Rate Not Displayed for an ECS?
- What Are the Impacts on ECS Metrics If UVP VMTools Is Not Installed on ECSs?
- Why Are the Inbound Bandwidth and Outbound Bandwidth Negative?
- Metric Descriptions
- User Permissions
-
General Consulting
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- API Overview
- Calling APIs
- API DescriptionAPI V1
- API v2
-
Permissions Policies and Supported Actions
- Introduction
- Supported Actions of the API Version Management APIs
- Supported Actions of the Metric Management API
- Supported Actions of the Alarm Rule Management APIs
- Supported Actions of the Monitoring Data Management APIs
- Supported Actions of the Quota Management API
- Supported Actions of the Event Monitoring API
- Common Parameters
- Appendix
- Change History
-
User Guide (Paris Region)
- Product Introduction
- Getting Started
- Monitoring Panels
- Using the Alarm Function
- Custom Monitoring
- Services Interconnected with Cloud Eye
- FAQs
- Change History
- API Reference (Paris Region)
-
User Guide (Kuala Lumpur Region)
- Product Introduction
- Getting Started
- Dashboards
- Resource Groups
- Using the Alarm Function
-
Server Monitoring
- Introduction to Server Monitoring
- Agent Installation and Configuration
- Agent Features per Version
- Installing and Configuring the Agent on a Linux ECS or BMS
- Installing and Configuring the Agent on a Windows ECS
- Installing the Agents in Batches on Linux ECSs
- Managing the Agent
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Custom Monitoring
- Event Monitoring
- Data Dump
- Auditing Operation Records on Cloud Eye
- Permissions Management
- Quota Adjustment
- Services Interconnected with Cloud Eye
-
FAQs
- General Consulting
-
Server Monitoring
- How Can I Quickly Restore the Agent Configuration?
- Why Is a BMS with the Agent Installed Displayed in the ECS List on the Server Monitoring Page?
- What OSs Does the Agent Support?
- What Statuses Does the Agent Have?
- What Should I Do If the Monitoring Period Is Interrupted or the Agent Status Keeps Changing?
- What Should I Do If the Service Port Is Used by the Agent?
- How Can I Create an Agency?
- What Can't I Create Another Agency?
- What Should I Do If Agency CESAgentAutoConfigAgency Failed to Be Automatically Created?
- What Can I Do If Agency CESAgentAutoConfigAgency Is Invalid?
- Will the Agent Affect the Server Performance?
- What Should I Do If the Agent Status Is Faulty?
-
Alarm Notifications or False Alarms
- What Is an Alarm Notification? How Many Types of Alarm Notifications Are There?
- What Alarm Status Does Cloud Eye Support?
- What Alarm Severities Does Cloud Eye Support?
- When Will an "Insufficient data" Alarm Be Triggered?
- How Can I Change the Mobile Number and Email Address for Receiving Alarm Notifications?
- How Can an IAM User Receive Alarm Notifications?
- Why Did I Receive a Bandwidth Overflow Notification While There Being No Bandwidth Overflow Record in the Monitoring Data?
-
Monitored Data Exceptions
- Why Is the Monitoring Data Not Displayed on the Cloud Eye Console?
- Why I Cannot See the Monitoring Data on the Cloud Eye Console After Purchasing Cloud Service Resources?
- Why Is OS Monitoring Data Not Displayed or Not Displayed Immediately After the Agent Is Installed and Configured on a server?
- Why Is Basic Monitoring Data Inconsistent with the Data Monitored by the OS?
- Why Are the Network Traffic Metric Values in Cloud Eye Different from Those Detected in ECS?
- Why Is the Metric Collection Point Lost During a Certain Period of Time?
- Why Are Memory Usage, Disk Usage, Inband Incoming Rate, and Inband Outgoing Rate Not Displayed for an ECS?
- What Are the Impacts on ECS Metrics If UVP VMTools Is Not Installed on ECSs?
- User Permissions
- Change History
- API Reference (Kuala Lumpur Region)
-
User Guide (Ankara Region)
- Product Introduction
- Getting Started
- Dashboards
- Resource Groups
- Using the Alarm Function
-
Server Monitoring
- Introduction to Server Monitoring
- Agent Installation and Configuration
- Installing and Configuring the Agent on a Linux ECS
- Installing and Configuring the Agent on a Windows ECS
- Installing the Agents in Batches on Linux ECSs
- Managing the Agent
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Custom Monitoring
- Event Monitoring
- Cloud Service Monitoring
- Permissions Management
- Quota Adjustment
- Services Interconnected with Cloud Eye
-
FAQs
- General Consulting
-
Server Monitoring
- How Can I Quickly Restore the Agent Configuration?
- What OSs Does the Agent Support?
- How Do I Query the Current Agent Version?
- What Should I Do If the Service Port Is Used by the Agent?
- How Can I Create an Agency?
- What Can't I Create Another Agency?
- What Should I Do If Agency CESAgentAutoConfigAgency Failed to Be Automatically Created?
- What Can I Do If Agency CESAgentAutoConfigAgency Is Invalid?
- Will the Agent Affect the Server Performance?
- What Should I Do If the Agent Status Is Faulty?
- Alarm Notifications or False Alarms
- Monitored Data Exceptions
- User Permissions
- Change History
- API Reference (Ankara Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Making an API Request
This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
Request URI
A request URI is in the following format:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
Parameter |
Description |
---|---|
URI-scheme |
Protocol used to transmit requests. All APIs use HTTPS. |
Endpoint |
Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints. For example, the endpoint of IAM in the my-kualalumpur-1 region is iam.my-kualalumpur-1.myhuaweicloud.com. |
resource-path |
Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens. |
query-string |
Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, ? limit=10 indicates that a maximum of 10 data records will be displayed. |
For example, to obtain an IAM token in the AP-Kuala Lumpur-OP6 region, obtain the endpoint of IAM (iam.my-kualalumpur-1.myhuaweicloud.com) for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:
1 |
https://iam.my-kualalumpur-1.myhuaweicloud.com/v3/auth/tokens |

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
Request Methods
Method |
Description |
---|---|
GET |
Requests the server to return specified resources. |
PUT |
Requests the server to update specified resources. |
POST |
Requests the server to add resources or perform special operations. |
DELETE |
Requests the server to delete specified resources, for example, an object. |
HEAD |
Same as GET except that the server must return only the response header. |
PATCH |
Requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created. |
For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
POST https://iam.my-kualalumpur-1.myhuaweicloud.com/v3/auth/tokens
Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
Parameter |
Description |
Mandatory |
Example Value |
---|---|---|---|
Host |
Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443. |
No This field is mandatory for AK/SK authentication. |
code.test.com or code.test.com:443 |
Content-Type |
Specifies the type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any. |
Yes |
application/json |
Content-Length |
Specifies the length of the request body. The unit is byte. |
No |
3495 |
X-Project-Id |
Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID. |
No |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Auth-Token |
Specifies the user token. It is a response to the API for obtaining a user token (This is the only API that does not require authentication). After the request is processed, the value of X-Subject-Token in the response header is the token value. |
No This field is mandatory for token authentication. |
The following is part of an example token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.
For more details, see "Authentication Using AK/SK" in Authentication.
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
POST https://iam.my-kualalumpur-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.
The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
POST https://iam.my-kualalumpur-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } |
If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot