查询阈值规则列表
功能介绍
该接口用于查询阈值规则列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/alarm-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
String |
分页信息。 |
limit |
否 |
Integer |
用于限制结果数据条数。 取值范围(0,1000],默认值为1000。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
Content-Type |
是 |
String |
指定类型为application/json。 枚举值:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
meta_data |
MetaData object |
查询结果元数据信息,包括分页信息等。 |
thresholds |
Array of QueryAlarmResult objects |
阈值规则查询参数。 |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
当前返回结果条数。 |
start |
String |
下一个开始的标记,用于分页,null表示无更多数据。 |
total |
Integer |
总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
action_enabled |
Boolean |
是否启用通知。 |
alarm_actions |
Array of strings |
告警状态通知列表。 |
alarm_advice |
String |
告警清除建议。 |
alarm_description |
String |
阈值规则描述。 |
alarm_level |
String |
告警级别。 |
alarm_rule_id |
String |
阈值规则ID。 |
alarm_rule_name |
String |
阈值规则名称。 |
comparison_operator |
String |
极限条件。 |
dimensions |
Array of Dimension objects |
时间序列维度。 |
evaluation_periods |
Integer |
间隔周期。 |
id_turn_on |
Boolean |
阈值规则是否启用。 |
insufficient_data_actions |
Array of strings |
数据不足通知列表。 |
metric_name |
String |
时间序列名称。 |
namespace |
String |
时间序列命名空间。 |
ok_actions |
Array of strings |
正常状态通知列表。 |
period |
Integer |
统计周期。 |
policy_name |
String |
阈值规则模板名称。 |
resources |
Array of strings |
资源信息(已废弃)。 |
state_reason |
String |
原因描述。 |
state_updated_timestamp |
String |
状态更新时间戳。 |
state_value |
String |
服务状态。 |
statistic |
String |
统计方式。 |
threshold |
String |
临界值。 |
type |
String |
阈值规则类型。 |
unit |
String |
阈值单元。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息描述。 |
error_type |
String |
错误类型。 |
trace_id |
String |
跟踪编号。主要用于开发人员快速搜索日志,定位问题。当返回的状态码为2xx时,trace_id为空;当返回4xx的状态码时,trace_id不为空。 |
请求示例
获取用户ID为 “Project_Id” 的用户的告警规则列表。
https://{EndPoint_Id}/v2/{Project_Id}/alarm-rules
响应示例
状态码: 200
OK 请求响应成功。
{ "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" } ] }
状态码: 400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.02003SVCSTG_AMS_4000123", "error_msg" : "The rule does not exist", "error_type" : "BAD_REQUEST", "trace_id" : "" }
SDK代码示例
SDK代码示例如下。
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()); } } } |
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) |
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。