Querying Event Configurations
Function
This API is used to query event configurations.
Call Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/event-specs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the ID, see Obtaining Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
spec_name |
No |
String |
Event configuration name. |
category |
No |
String |
Event type |
severity |
No |
String |
Event severity |
source_type |
No |
String |
Event source type |
tag |
No |
String |
Tag |
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
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number of event configurations. |
event_specs |
Array of EventSpecResponse objects |
Event configuration list |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Event configuration ID |
name |
String |
Event configuration definition name |
display_name |
String |
Event configuration display name |
description |
String |
Event configuration description |
subject |
String |
Event |
category |
String |
Event type |
severity |
String |
Event severity |
source_type |
String |
Event source type |
name_space |
String |
Service |
Example Request
https://{Endpoint}/v2/{project_id}/event-specs
Example Response
Status code: 200
The cluster query event is configured successfully.
{ "event_specs" : [ { "id" : "fa6e1502-9d08-48c7-900c-26d3b5bd6078", "name" : "configureMRSExtDataSourcesSuccess", "description": "Succeeded in configuring the MRS data source for the cluster %s." "subject": "DWS event notification" "category" : "management", "severity" : "normal", "display_name": "MRS data source configured successfully." "source_type" : "cluster", "name_space" : "dws" } ], "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 49 50 |
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 ListEventSpecsSolution { 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(); ListEventSpecsRequest request = new ListEventSpecsRequest(); request.withSpecName("<spec_name>"); request.withCategory("<category>"); request.withSeverity("<severity>"); request.withSourceType("<source_type>"); request.withTag("<tag>"); try { ListEventSpecsResponse response = client.listEventSpecs(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 33 34 |
# 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 = ListEventSpecsRequest() request.spec_name = "<spec_name>" request.category = "<category>" request.severity = "<severity>" request.source_type = "<source_type>" request.tag = "<tag>" response = client.list_event_specs(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 41 42 43 44 45 |
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.ListEventSpecsRequest{} specNameRequest:= "<spec_name>" request.SpecName = &specNameRequest categoryRequest:= "<category>" request.Category = &categoryRequest severityRequest:= "<severity>" request.Severity = &severityRequest sourceTypeRequest:= "<source_type>" request.SourceType = &sourceTypeRequest tagRequest:= "<tag>" request.Tag = &tagRequest response, err := client.ListEventSpecs(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 event configuration 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. |
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