Updated on 2024-04-18 GMT+08:00

Querying Alarm Details List

Function

This API is used to query the alarm details list.

Call Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/alarms
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

time_zone

Yes

String

Time zone

offset

No

String

Current page The default value is 1, and the maximum value is 10000.

limit

No

String

Number of displayed records. A maximum of 1000 pieces are supported.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

count

Integer

Total number of alarm details

alarm_details

Array of AlarmDetailResponse objects

Alarm detail list

Table 4 AlarmDetailResponse

Parameter

Type

Description

alarm_id

String

Alarm definition ID

alarm_name

String

Alarm name

alarm_level

String

Alarm severity, which can be:

  • urgent
  • important
  • minor
  • prompt

alarm_source

String

Alarm service

alarm_message

String

Alarm message

alarm_location

String

Alarm location

resource_id

String

ID of the alarm source

resource_id_name

String

Alarm source name

alarm_generate_date

String

Alarm date

alarm_status

String

Alarm status

Example Request

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarms?time_zone=GMT

Example Response

Status code: 200

{
  "alarm_details" : [ {
    "alarm_id" : "DWS_01010",
"alarm_name": "Cluster status is abnormal.",
    "alarm_level" : "1",
    "alarm_source" : "DWS",
    "alarm_message" : "CloudService=DWS, resourceId: 5e76e8e2-d0cf-4b64-9d9a-aadbb04b54f7, resourceIdName: z30013507-evs-09, domain_name=EI_dws_lwx565140, domain_id=0676610f3a0a4c2c80c50bea7ddf18c1, res_domain_name=op_svc_dws_0676610f3a0a4c2c80c50bea7ddf18c1",
"alarm_location": "cluster_id: 5e76e8e2-d0cf-4b64-9d9a-aadbb04b54f7, cluster_name: z30013507-evs-09: cluster_type: dws, domain_name:  EI_dws_demo,domain_id: 0676610f3a0a4c2c80c50bea7ddf18c1,",
    "resource_id" : "5e76e8e2-d0cf-4b64-9d9a-aadbb04b54f7",
    "resource_id_name" : "z30013507-evs-09",
    "alarm_generate_date" : "2022-10-27 08:11:29",
    "alarm_status" : "0"
  } ],
  "count" : 1
}

SDK Sample Code

The sample code is as follows:

 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
48
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListAlarmDetailSolution {

    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);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAlarmDetailRequest request = new ListAlarmDetailRequest();
        request.withTimeZone("<time_zone>");
        request.withOffset("<offset>");
        request.withLimit("<limit>");
        try {
            ListAlarmDetailResponse response = client.listAlarmDetail(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());
        }
    }
}
 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

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAlarmDetailRequest()
        request.time_zone = "<time_zone>"
        request.offset = "<offset>"
        request.limit = "<limit>"
        response = client.list_alarm_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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 := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAlarmDetailRequest{}
	request.TimeZone = "<time_zone>"
	offsetRequest:= "<offset>"
	request.Offset = &offsetRequest
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	response, err := client.ListAlarmDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The alarm details list is queried successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.