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

Querying a Threshold Rule

Updated on 2022-06-01 GMT+08:00

Function

This API is used to query a threshold rule.

URI

GET /v1/{project_id}/ams/alarms/{alarm_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

alarm_id

Yes

String

Threshold rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Project-level token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json.

Enumeration values:

  • application/json

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

errorCode

String

Response code.

errorMessage

String

Response message.

metaData

MetaData object

Metadata, including pagination information.

thresholds

Array of AlarmAPIQueryAlarmResult objects

Threshold rule list.

Table 4 MetaData

Parameter

Type

Description

count

Integer

Number of records that can be returned.

start

String

Start of the next page, which is used for pagination. null: No more data.

total

Integer

Total number of records.

Table 5 AlarmAPIQueryAlarmResult

Parameter

Type

Description

idTurnOn

Boolean

Whether to enable the threshold rule.

type

String

Threshold rule type.

policyName

String

Threshold rule template name.

alarmName

String

Threshold rule name.

id

String

Threshold rule ID.

alarmDescription

String

Threshold rule description.

actionEnabled

Boolean

Whether to enable notification.

okActions

Array of strings

Action to be taken when restoration is complete.

alarmActions

Array of strings

Action to be taken when an alarm is reported.

insufficientDataActions

Array of strings

Action to be taken when data is insufficient.

stateValue

String

Service status.

stateReason

String

Cause description.

stateUpdatedTimestamp

String

Time when the status was updated.

metricName

String

Time series name.

namespace

String

Namespace of time series objects.

statistic

String

Statistic.

dimensions

Array of Dimension objects

List of time series dimensions.

resources

Array of strings

Resource information (discarded).

period

Integer

Statistical period.

evaluationPeriods

Integer

Number of consecutive periods.

unit

String

Threshold unit.

threshold

String

Threshold value.

comparisonOperator

String

Comparison operator.

alarmAdvice

String

Alarm clearance suggestion.

alarmLevel

String

Alarm severity.

Table 6 Dimension

Parameter

Type

Description

name

String

Dimension name.

value

String

Dimension value.

Example Requests

Query a threshold rule.

GET https://{Endpoint}/v1/{project_id}/ams/alarms/{alarm_id}

Example Responses

Status code: 200

OK: The request is successful.

{
  "errorCode" : "SVCSTG_AMS_2000000",
  "errorMessage" : "success",
  "metaData" : {
    "count" : 10,
    "start" : null,
    "total" : 100
  },
  "thresholds" : [ {
    "id" : "2137",
    "alarmName" : "aaaaaaaa",
    "alarmDescription" : "",
    "actionEnabled" : false,
    "okActions" : [ ],
    "alarmActions" : [ ],
    "insufficientDataActions" : [ ],
    "stateValue" : "alarm",
    "stateReason" : "",
    "stateUpdatedTimestamp" : null,
    "metricName" : "cpuCoreLimit",
    "namespace" : "PAAS.CONTAINER",
    "statistic" : "average",
    "dimensions" : [ {
      "name" : "appName",
      "value" : "rhm-broker"
    } ],
    "period" : 60000,
    "evaluationPeriods" : 1,
    "unit" : "Core",
    "threshold" : "0",
    "comparisonOperator" : ">=",
    "alarmAdvice" : "",
    "alarmLevel" : 3
  } ]
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request: Invalid request. The client should not repeat the request without modifications.

401

Unauthorized: The authorization information is incorrect or invalid.

403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.

503

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

Error Codes

See Error Codes.

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