Obtaining the Silence Rule List
Function
This API is used to obtain the silence rule list.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/alert/mute-rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum: 32 Maximum: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. Minimum: 1 Maximum: 40960 |
Content-Type |
Yes |
String |
Content type, which is application/json. Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of MuteRule objects |
OK: The request is successful. |
Parameter |
Type |
Description |
---|---|---|
create_time |
Long |
Creation time. Minimum: 0 Maximum: 9999999999999 |
desc |
String |
Rule description. Minimum: 0 Maximum: 1024 |
match |
Array<Array<Match>> |
Match condition of the rule. Up to 10 serial or parallel conditions can be created. Array Length: 1 - 10 |
mute_config |
MuteConfig object |
Time when the rule takes effect. |
name |
String |
Rule name. Enter a maximum of 100 characters and do not start or end with an underscore (_). Only letters, digits, and underscores are allowed. Minimum: 1 Maximum: 100 |
timezone |
String |
Time zone. Minimum: 1 Maximum: 32 |
update_time |
Long |
Modification time. Minimum: 0 Maximum: 9999999999999 |
user_id |
String |
User ID. Minimum: 32 Maximum: 32 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key specified in the metadata for matching. Minimum: 1 Maximum: 128 |
operate |
String |
Match mode. EXIST: Exist. REGEX: Regular expression. EQUALS: Equal to. Minimum: 1 Maximum: 100 Enumeration values:
|
value |
Array of strings |
Value corresponding to the key. If operate is set to EXIST, this parameter is left empty. Minimum: 1 Maximum: 256 Array Length: 0 - 5 |
Parameter |
Type |
Description |
---|---|---|
ends_at |
Long |
End time of the silence rule. Minimum: 0 Maximum: 999999999 |
scope |
Array of integers |
When type is set to WEEKLY or MONTHLY, scope cannot be empty. Minimum: 0 Maximum: 31 Array Length: 1 - 100 |
starts_at |
Long |
Start time of the silence rule. Minimum: 0 Maximum: 999999999 |
type |
String |
Type of the time for the silence rule to take effect. FIXED: Fixed time. DAILY: Certain time every day. WEEKLY: Certain time every week. MONTHLY: Certain time every month. Minimum: 1 Maximum: 100 Enumeration values:
|
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 12 Maximum: 12 |
error_msg |
String |
Error message. Minimum: 0 Maximum: 1024 |
error_type |
String |
Error type. Minimum: 0 Maximum: 128 |
trace_id |
String |
Request ID. Minimum: 32 Maximum: 32 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 12 Maximum: 12 |
error_msg |
String |
Error message. Minimum: 0 Maximum: 1024 |
error_type |
String |
Error type. Minimum: 0 Maximum: 128 |
trace_id |
String |
Request ID. Minimum: 32 Maximum: 32 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 13 Maximum: 13 |
error_msg |
String |
Response message. Minimum: 1 Maximum: 100 |
trace_id |
String |
Response ID. Minimum: 12 Maximum: 12 |
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 |
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"); ICredential auth = new BasicCredentials() .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 |
# 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 = 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 |
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.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