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

Integration Management

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

This API is used by users to access the alarm data.

Function

Tenants can integrate their self-developed monitoring systems into the COC based on standards. After the integration, alarms are reported to the COC alarm center in the standard format.

URI

POST /v1/event/huawei/custom/{integration_key}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

integration_key

Yes

String

Integration ID.

Minimum length: 1 character

Maximum length: 255 characters

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

alarmId

Yes

String

Alarm id

Minimum length: 1 character

Maximum length: 255 characters

alarmName

Yes

String

Alarm name

Minimum length: 1 character

Maximum length: 255 characters

alarmLevel

Yes

String

Alarm severity. The value can be Critical, Major, Minor, or Info.

Minimum length: 1 character

Maximum length: 255 characters

The value can be:

  • Critical
  • Major
  • Minor
  • Info

time

Yes

Long

Time when an alarm is generated

nameSpace

Yes

String

Namespace of a service

Minimum length: 1 character

Maximum length: 255 characters

regionId

No

String

ID of the region where the alarm is generated

Minimum length: 0 character

Maximum length: 255 characters

applicationId

Yes

String

Application ID

Minimum length: 1 character

Maximum length: 255 characters

resourceName

No

String

Resource name

Minimum length: 0 character

Maximum length: 255 characters

resourceId

No

String

Resource ID

Minimum length: 0 character

Maximum length: 255 characters

alarmDesc

Yes

String

Alarm description

Minimum length: 1 character

Maximum length: 255 characters

URL

No

String

Original alarm URL

Minimum length: 0 character

Maximum length: 255 characters

alarmStatus

No

String

Alarm status. The value can be alarm (in alarm) or ok (alarm restored).

Minimum length: 0 character

Maximum length: 255 characters

The value can be:

  • alarm
  • ok

alarmSource

Yes

String

Alarm Sources

Minimum length: 1 character

Maximum length: 255 characters

additional

No

Object

Supplementary information about the alarm

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

provider_code

String

Service ID.

Default value: 049

Minimum length: 0 character

Maximum length: 256 characters

error_code

String

Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases.

Default: 0

Minimum length: 0 character

Maximum length: 256 characters

error_msg

String

Request response description.

Minimum length: 0 character

Maximum length: 256 characters

Request Example

https://coc.myhuaweicloud.com/v1/event/huawei/custom/{integration_key}

{
  "alarmId" : "18cfxxxxxxxxxx0f8",
  "alarmName": "CPU Usage Exceeding Threshold",
  "alarmLevel" : "Critical",
  "time" : 1709118444540,
  "nameSpace" : "shanghai",
  "regionId" : "cn-north-4",
  "applicationId" : "18cfa0a5ef8d",
  "resourceName" : "machine-1",
  "resourceId" : "18cxxxxxxxxxxxxff68625",
  "alarmDesc" : "string",
  "URL" : "https://example.com",
  "alarmStatus" : "alarm",
  "alarmSource" : "coc",
  "additional" : { }
}

Response Example

Status code: 200

The request is successful.

{
  "error_code" : "COC.00000000",
  "error_msg" : "success",
  "data" : null,
  "provider_code" : "049"
}

Status code: 400

Incorrect request body.

{
  "error_code" : "COC.00000001",
  "error_msg" : "alarmName must not be null | alarmId must not be null",
  "data" : null,
  "provider_code" : "049"
}

Status code: 401

Authentication error.

{
  "error_code" : "common.01010001",
  "error_msg" : "Token missing or invalid.",
  "data" : null,
  "provider_code" : "049"
}

Status Code

Status Code

Description

200

Request succeeded.

400

Incorrect request body.

401

Authentication error.

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