Obtaining the Silence Rule List
Function
This API is used to obtain the silence rule list.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
aom:muteRule:list
List
-
-
-
-
URI
GET /v2/{project_id}/alert/mute-rules
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details, see Obtaining a Token. |
|
Content-Type |
No |
String |
Message body type or format. Content type, which is application/json. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
[items] |
Array of MuteRule objects |
Silence rule. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_time |
Long |
Definition Time when the silence rule was created (UTC timestamp, in milliseconds). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool. Constraints N/A Range N/A Default Value N/A |
|
desc |
String |
Definition Rule description. Constraints Max. characters: 1,024 Range N/A Default Value N/A |
|
match |
Array<Array<Match>> |
Definition Match condition of the rule. Constraints A maximum of 10 parallel conditions can be configured, and each parallel condition can contain a maximum of 10 serial conditions. A maximum of 100 conditions can be configured. |
|
mute_config |
MuteConfig object |
Definition Time when the rule takes effect. Constraints N/A |
|
name |
String |
Definition Rule name. Constraints Enter a maximum of 100 characters, which cannot start or end with an underscore (_). Only letters, digits, and underscores are allowed. Range N/A Default Value N/A |
|
timezone |
String |
Definition Time zone. Constraints N/A Range N/A Default Value N/A |
|
update_time |
Long |
Definition Time when the silence rule was modified (UTC timestamp, in milliseconds). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool. Constraints N/A Range N/A Default Value N/A |
|
user_id |
String |
Definition ID of the user who created the silence rule. The actual value is the same as the project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
Definition Key specified in the metadata for matching. Constraints N/A Range Min. characters: 1 Max. characters: 128 Default Value N/A |
|
operate |
String |
Definition Matching method of the alarm rule. Constraints N/A Range Default Value N/A |
|
value |
Array of strings |
Definition Value of the key. Constraints N/A Range Min. characters of an element: 1 Max. characters of an element: 256 Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
ends_at |
Long |
Definition End time of the silence rule (UTC timestamp, in milliseconds). If the silence rule is permanent, set this parameter to 0. Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool. Constraints N/A Range N/A Default Value N/A |
|
scope |
Array of integers |
Definition Silence scope. Constraints When type is set to WEEKLY or MONTHLY, scope cannot be empty. Range Min. value of an element: 0 Max. value of an element: 31 Default Value N/A |
|
starts_at |
Long |
Definition Start time of the silence rule (UTC timestamp, in milliseconds). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool. Constraints N/A Range N/A Default Value N/A |
|
type |
String |
Definition Type of the time for the silence rule to take effect. Constraints N/A Range Default Value N/A |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Definition Error code. Range N/A |
|
error_msg |
String |
Definition Error message. Range N/A |
|
error_type |
String |
Definition Error type. Range N/A |
|
trace_id |
String |
Definition Request ID. Range N/A |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Definition Error code. Range N/A |
|
error_msg |
String |
Definition Error message. Range N/A |
|
error_type |
String |
Definition Error type. Range N/A |
|
trace_id |
String |
Definition Request ID. Range N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Response code. |
|
error_msg |
String |
Response message. |
|
trace_id |
String |
Response ID. |
Example Requests
Obtain the silence rule list.
https://{Endpoint}/v2/{project_id}/alert/mute-rules
Example Responses
Status code: 200
OK: The request is successful.
[ {
"create_time" : 1668147671966,
"desc" : "",
"match" : [ [ {
"key" : "event_severity",
"operate" : "EQUALS",
"value" : [ "Info" ]
} ] ],
"mute_config" : {
"ends_at" : 86399,
"scope" : [ ],
"starts_at" : 0,
"type" : "DAILY"
},
"name" : "32255",
"timezone" : "xxx",
"update_time" : 1668147671966,
"user_id" : "2a473356cca5487f8373be891bffc1cf"
} ]
Status code: 401
Unauthorized: The authentication information is incorrect or invalid.
{
"error_code" : "AOM.0403",
"error_msg" : "auth failed.",
"error_type" : "AUTH_FAILED",
"trace_id" : null
}
Status code: 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.
{
"error_code" : "AOM.0403",
"error_msg" : "auth failed.",
"error_type" : "AUTH_FAILED",
"trace_id" : null
}
Status code: 500
Internal Server Error: The server is able to receive the request but unable to understand the request.
{
"error_code" : "APM.00000500",
"error_msg" : "Internal Server Error",
"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 ListMuteRuleSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListMuteRuleRequest request = new ListMuteRuleRequest(); try { ListMuteRuleResponse response = client.listMuteRule(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 |
# 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListMuteRuleRequest() response = client.list_mute_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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListMuteRuleRequest{} response, err := client.ListMuteRule(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. |
|
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. |
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