{"base_path":"/","components":null,"consumes":"","definitions":{"AlarmNamespaceEnum":{"description":"告警命名空间,取值范围:SYS.CBR,SYS.RDS,SYS.GaussDB","enum":["SYS.CBR","SYS.RDS","SYS.GaussDB"],"example":"SYS.CBR","type":"string"},"AlarmRuleEntity":{"description":"告警规则实体类","properties":{"alarm_id":{"description":"告警规则ID","type":"string"},"alarm_notifications":{"description":"告警触发的动作","type":"string"},"alarm_template_id":{"description":"告警规则关联告警模板ID","type":"string"},"description":{"description":"告警描述","type":"string"},"enabled":{"description":"告警开关","type":"boolean"},"enterprise_project_id":{"description":"企业项目ID","type":"string"},"name":{"description":"告警名称","type":"string"},"namespace":{"$ref":"#/definitions/AlarmNamespaceEnum"},"notification_begin_time":{"description":"告警通知开启时间","type":"string"},"notification_enabled":{"description":"是否开启告警通知","type":"boolean"},"notification_end_time":{"description":"告警通知关闭时间","type":"string"},"ok_notifications":{"description":"告警恢复触发的动作","type":"string"},"policies":{"description":"告警策略","type":"string"},"region_id":{"description":"RegionID","type":"string"},"resources":{"description":"资源列表","type":"string"},"type":{"description":"告警类型","type":"string"}},"required":["alarm_id"],"type":"object"},"ErrorRsp":{"description":"失败时返回的错误对象","properties":{"error_code":{"description":"错误码","maxLength":36,"minLength":8,"type":"string"},"error_msg":{"description":"错误描述","maxLength":512,"minLength":2,"type":"string"}},"required":["error_code","error_msg"]},"ListAlarmRulesResponseBody":{"description":"查询告警规则列表","properties":{"alarm_rules":{"description":"告警规则","items":{"$ref":"#/definitions/AlarmRuleEntity"},"maxItems":100,"minItems":0,"type":"array"},"count":{"description":"告警规则总条数","exclusiveMaximum":true,"format":"int64","maximum":65535,"minimum":0,"type":"integer"}},"required":["count","alarm_rules"],"type":"object"}},"description":null,"group_id":"0cb6191c2c524d62be604224b207d979","host":"bcc.cn-north-4.myhuaweicloud.com","id":"7c569164c5e34b84bdc5de6d33d7df1c","info_version":"v1","method":"get","name":"ListAlarmRules","parameters":{},"paths":{"/v1/{domain_id}/alarm-rules":{"get":{"description":"查询告警规则列表","operationId":"ListAlarmRules","parameters":[{"description":"账号ID","in":"path","maxLength":32,"minLength":16,"name":"domain_id","pattern":"^[a-z0-9]{16,32}$","required":true,"type":"string"},{"description":"告警命名空间,取值范围:SYS.CBR,SYS.RDS,SYS.GaussDB","enum":["SYS.CBR","SYS.RDS","SYS.GaussDB"],"in":"query","maxLength":16,"minLength":2,"name":"namespace","required":false,"type":"string"},{"description":"RegionID","in":"query","maxLength":32,"minLength":6,"name":"region_id","pattern":"^[a-z0-9-]{6,32}$","required":false,"type":"string"},{"description":"告警规则ID","in":"query","maxLength":24,"minLength":24,"name":"alarm_rule_id","pattern":"^[0-9a-zA-Z]{24}$","required":false,"type":"string"},{"default":0,"description":"分页起始值,默认值为0。","exclusiveMaximum":true,"format":"int64","in":"query","maximum":65535,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"单次查询的条数限制,取值范围(0,100],默认值为100,用于限制结果数据条数。","format":"int32","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"列举告警规则成功","examples":{"application/json":{"alarm_rules":[{"alarm_id":"al1648354591415NnDDdewNe","alarm_notifications":"[{\"type\":\"notification\",\"notification_list\":[\"urn:smn:region-xx-7:f3329ef1d6bc4ce9acbcef0c510de736:MapDS-Manager\"]}]","alarm_template_id":null,"description":"","enabled":true,"enterprise_project_id":"0","name":"alarm-ch9j","namespace":"SYS.RDS","notification_begin_time":"00:00","notification_enabled":true,"notification_end_time":"23:59","ok_notifications":"[]","policies":"[{\"metric_name\":\"PrimaryStandbySwitched\",\"period\":0,\"filter\":\"average\",\"comparison_operator\":\">=\",\"value\":1.0,\"unit\":\"count\",\"count\":1,\"suppress_duration\":null,\"level\":2}]","region_id":"region-xx-7","resources":"[{\"resource_group_id\":null,\"resource_group_name\":null,\"dimensions\":[]}]","type":"EVENT.SYS"}],"count":4}},"schema":{"$ref":"#/definitions/ListAlarmRulesResponseBody"}},"400":{"description":"请求错误。","schema":{"$ref":"#/definitions/ErrorRsp"}},"401":{"description":"未提供认证信息或认证信息错误。","schema":{"$ref":"#/definitions/ErrorRsp"}},"403":{"description":"请求页面被禁止访问。","schema":{"$ref":"#/definitions/ErrorRsp"}},"404":{"description":"未找到资源。","schema":{"$ref":"#/definitions/ErrorRsp"}},"408":{"description":"请求超出了服务器的等待时间。","schema":{"$ref":"#/definitions/ErrorRsp"}},"429":{"description":"当前请求过多。","schema":{"$ref":"#/definitions/ErrorRsp"}},"500":{"description":"请求未完成,服务异常。","schema":{"$ref":"#/definitions/ErrorRsp"}},"503":{"description":"系统暂时不可用,请求受限。","schema":{"$ref":"#/definitions/ErrorRsp"}}},"summary":"查询告警规则列表","tags":["告警管理"],"x-api-type":"open-api","x-iam-auth-meta-anno":{"abacAction":"bcc::listAlarmRule","authContextInitializerName":"baseIamAuthContextInitializer","authLevel":"NO_INSTANCE","model":"v5","needAbacCheck":true,"needAbacResourceCheck":false,"needApigwJwtAuthCheck":false,"needCbcCheck":false,"needRbacCheck":false,"needResourceTagCheck":false,"supportAllGrantedEps":false},"x-is-registered":"Y","x-request-examples-1":"https://{endpoint}/v1/{domain_id}/alarm-rules?region_id=&resource_type=&alarm_rule_id=&offset=&limit=1","x-request-examples-text-1":"https://{endpoint}/v1/{domain_id}/alarm-rules?region_id=&resource_type=&alarm_rule_id=&offset=&limit=1","x-request-examples-url-1":"GET https://{endpoint}/v1/{domain_id}/alarm-rules","x-support-sdk":"Y"}}},"product_short":"BCC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询告警规则列表","tags":"告警管理","uri":null,"version":"2.0"}