Querying the Threshold Rule List
Function
This API is used to query the threshold rule list.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/alarm-rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
String |
Pagination information. |
limit |
No |
Integer |
Maximum number of returned records. Value range: 1–1000. Default value: 1000. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. |
Content-Type |
Yes |
String |
Content type, which is application/json. Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
meta_data |
MetaData object |
Metadata, including pagination information. |
thresholds |
Array of QueryAlarmResult objects |
Parameters specified for querying a threshold rule. |
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Number of returned records. |
start |
String |
Start of the next page, which is used for pagination. null: No more data. |
total |
Integer |
Total number of records. |
Parameter |
Type |
Description |
---|---|---|
action_enabled |
Boolean |
Whether to enable notification. |
alarm_actions |
Array of strings |
List of alarm notifications. |
alarm_advice |
String |
Alarm clearance suggestion. |
alarm_description |
String |
Threshold rule description. |
alarm_level |
String |
Alarm severity. |
alarm_rule_id |
String |
Threshold rule ID. |
alarm_rule_name |
String |
Threshold rule name. |
comparison_operator |
String |
Comparison operator. |
dimensions |
Array of Dimension objects |
List of time series dimensions. |
evaluation_periods |
Integer |
Interval. |
id_turn_on |
Boolean |
Whether to enable the threshold rule. |
insufficient_data_actions |
Array of strings |
List of insufficient data notifications. |
metric_name |
String |
Time series name. |
namespace |
String |
Time series objects' namespace. |
ok_actions |
Array of strings |
List of normal status notifications. |
period |
Integer |
Statistical period. |
policy_name |
String |
Threshold rule name. |
resources |
Array of strings |
Resource information (discarded). |
state_reason |
String |
Cause description. |
state_updated_timestamp |
String |
Time when the status was updated. |
state_value |
String |
Service status. |
statistic |
String |
Statistic. |
threshold |
String |
Threshold value. |
type |
String |
Threshold rule type. |
unit |
String |
Threshold unit. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Dimension name. |
value |
String |
Dimension value. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
error_type |
String |
Error type. |
trace_id |
String |
Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty. |
Example Requests
Obtain the alarm rule list of a user whose ID is Project_Id.
https://{EndPoint_Id}/v2/{Project_Id}/alarm-rules
Example Responses
Status code: 200
OK: The request is successful.
{ "meta_data" : [ { "count" : 10, "total" : 100 } ], "thresholds" : [ { "action_enable" : false, "alarm_actions" : null, "alarm_advice" : null, "alarm_description" : null, "alarm_level" : 3, "alarm_rule_id" : 2137, "alarm_rule_name" : "aom_rule", "comparison_operator" : ">=", "dimensions" : [ { "name" : "appName" }, { "value" : "rhm-broker" } ], "evaluation_periods" : 1, "id_turn_on" : true, "insufficient_data_actions" : null, "metric_name" : "cpuCoreLimit", "namespace" : "PAAS.CONTAINER", "ok_actions" : null, "period" : 60000, "policy_name" : "23,", "resources" : [ ], "state_reason" : null, "state_updated_timestamp" : null, "state_value" : "alarm", "statistic" : "average", "threshold" : 0, "type" : "single,", "unit" : "Core" } ] }
Status code: 400
Bad Request: The request is invalid. The client should not repeat the request without modifications.
{ "error_code" : "AOM.02003SVCSTG_AMS_4000123", "error_msg" : "The rule does not exist", "error_type" : "BAD_REQUEST", "trace_id" : "" }
SDK Sample Code
The SDK sample code is as follows.
Java
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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; public class ListAlarmRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListAlarmRuleRequest request = new ListAlarmRuleRequest(); request.withOffset("<offset>"); request.withLimit(<limit>); try { ListAlarmRuleResponse response = client.listAlarmRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
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 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAlarmRuleRequest() request.offset = "<offset>" request.limit = <limit> response = client.list_alarm_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAlarmRuleRequest{} offsetRequest:= "<offset>" request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest response, err := client.ListAlarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
400 |
Bad Request: The request is invalid. The client should not repeat the request without modifications. |
401 |
Unauthorized: The authentication 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.
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