Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page

API Monitoring

Updated on 2024-11-26 GMT+08:00

Introduction

API monitors monitor the API gateway of your service, and control the resolution result of the DNS entry based on the availability of API gateway.

Table 1 Monitoring status description

Monitoring Status

Description

Green

The monitoring is normal.

Red

The monitoring is abnormal. Traffic switchover is automatically triggered when the status changes from normal to failed.

Yellow

The monitor initialization failed. The MAS process cannot detect the service API. In this case, confirm the configurations or contact O&M personnel.

Light gray

Monitor creation or configuration failed.

Dark gray

Invocation failed. The ETCD connection status is abnormal.

Creating an API Monitor

  1. Log in to the MAS console. On the Multi-Active Instances page, click an instance whose namespace type is Intra-city multi-active.
  2. Click the Monitor List tab and click Create Monitor.
  3. Configure the basic information, then click Next: Data Centers.

    Figure 1 Basic information configurations
    Table 2 Basic information parameters

    Parameter

    Description

    Monitor

    Select API Monitoring.

    Application

    Select the application.

    Monitor Name

    Customize the monitor name.

    Exception Notification

    By default, this option is disabled.

    If it is enabled,

    • Monitor and API exceptions will be sent to you in a timely manner with the Huawei Cloud SMN service. Configure a secret key first.
    • Cloud Eye is enabled by default. Ensure that the alarm rules for MAS have been created on the Cloud Eye console. For details, see Creating an Alarm Rule to Monitor an Event.

    Subject

    If Exception Notification is enabled, select a subject from the drop-down list or click Add to create a new one.

    Monitoring

    The default value is Yes. If you select No, the API gateway status will not be monitored.

  4. Configure the data centers, then click Next: Advanced.

    Figure 2 Data center configurations

    Table 3 Data center parameters

    Parameter

    Description

    Cloud

    Select the environment where the monitored API gateway is deployed.

    Region

    Select the regions of the API gateways.

    Connection Address

    Select HTTP or HTTPS, and enter the connection address of the API gateway.

    Request path

    Health check path of the API gateway.

    Request Methods

    Select GET, POST, DELETE, PATCH, or PUT.

    Status Code

    Set this parameter based on the actual requirements of the monitored API gateway, for example, 200.

    Request Header

    Set this parameter based on the actual requirements of the monitored API gateway.

    Encrypt the request header if it contains sensitive information.

  5. Configure the advanced settings, then click Next: Confirm.

    Figure 3 Advanced configurations
    Table 4 Advanced settings

    Parameter

    Description

    Retry Interval (ms)

    The interval of reconnection attempts, in milliseconds. Default value (recommended): 5000

    Value range: 1 to 300,000

    Healthy Threshold

    If the number of successful consecutive API connections reaches or exceeds the threshold, the API connection is normal.

    NOTE:

    Default value (recommended): 2; Value range: 1 to 5

    Unhealthy Threshold

    If the number of consecutive API connection failures reaches or exceeds the threshold, the API connection is abnormal.

    NOTE:

    Default value (recommended): 3; Value range: 3 to 10

  6. Confirm settings and click Create.

    NOTE:

    If the created monitor is not normal, that is, its indicator is not green, its configurations or APIs may be abnormal. In this case, rectify the fault.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback