huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"AlertNoticeConfig":{"example":{"description":"","enabled":true,"is_all_enterprise_project":true,"local":"zh-cn","name":"test","notice_class":"threat_alert_notice","prefer_html":false,"sendfreq":30,"threat":["all"],"times":1,"topic_urn":"urn:smn:cn-north-7:550500b49078408682d0d4f7d923f3e1:ces_lgs_test"},"properties":{"description":{"description":"**参数解释:**\n描述,对告警通知配置的补充说明\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"enabled":{"default":true,"description":"**参数解释:**\n是否开启告警,控制该告警通知配置的启用/禁用状态\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"boolean"},"id":{"description":"**参数解释:**\n告警id,用于唯一标识一条告警通知配置\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"is_all_enterprise_project":{"description":"**参数解释:**\n是否所有企业项目,标识该告警配置是否适用于所有企业项目\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"boolean"},"local":{"default":"zh-cn","description":"**参数解释:**\n地区,指定告警通知的语言或地域相关配置\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"name":{"description":"**参数解释:**\n告警名称,用于标识告警通知配置的名称\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"nearly_expired_time":{"description":"**参数解释:**\n提前通知天数,针对过期类告警提前发送通知的天数\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","format":"int64","type":"integer"},"notice_class":{"default":"threat_alert_notice","description":"**参数解释:**\n告警类型,区分不同场景的告警(如防护规则触发、资源异常等)\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"prefer_html":{"default":false,"description":"预留参数,可忽略","type":"boolean"},"sendfreq":{"default":30,"description":"**参数解释:**\n通知频率,控制告警通知的发送间隔\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"integer"},"threat":{"default":["all"],"description":"告警的事件类型","items":{"type":"string"},"type":"array"},"times":{"default":1,"description":"**参数解释:**\n通知频率(补充说明,与sendfreq协同控制告警发送频次)\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"integer"},"topic_urn":{"description":"**参数解释:**\n通知模板,关联用于发送告警通知的SMN主题URN\n查询可使用的主题,通过 云日志服务的“查询SMN主题”接口,返回体中的\"topic_urn\"字段\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"}}},"AlertNoticeConfigList":{"example":{"alert_notice_configs":[{"id":"alert_notice_configs_id"}]},"properties":{"alert_notice_configs":{"description":"**参数解释:**\n告警通知配置列表,包含多条告警通知配置信息\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"$ref":"#/definitions/AlertNoticeConfig"},"type":"array"}},"required":["alert_notice_configs"]},"BatchDeleteAlertNoticeConfigBody":{"example":{"alert_notice_configs":[{"id":"alert_notice_configs_id"}]},"properties":{"alert_notice_configs":{"description":"**参数解释:**\n需要删除的告警id列表\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"$ref":"#/definitions/DeleteAlertNoticeConfigBody"},"type":"array"}},"required":["alert_notice_configs"]},"DeleteAlertNoticeConfigBody":{"properties":{"id":{"description":"**参数解释:**\n告警id,用于唯一标识一条告警通知配置,id请查看”查询告警通知配置“接口\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"}}},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"RestErrorResponse":{"properties":{"details":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。","items":{"$ref":"#/definitions/IAM5ErrorDetails"},"type":"array"},"encoded_authorization_message":{"description":"编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。","type":"string"},"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误信息","type":"string"}},"title":"RestErrorResponse","type":"object"}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"a41dcd74e367473e8a5a7d83cece71b0","info_version":"v1","method":"post","name":"BatchDeleteAlertNoticeConfig","parameters":{},"paths":{"/v2/{project_id}/waf/alert/batch-delete":{"post":{"description":"批量删除告警通知","operationId":"BatchDeleteAlertNoticeConfig","parameters":[{"description":"**参数解释:**\n企业项目ID\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"query","name":"enterpriseProjectId","required":true,"type":"string"},{"description":"**参数解释:**\n项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。\n**约束限制:**\n不涉及\n**取值范围:**\n只能由英文字母、数字组成,且长度为32个字符。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"description":"语言,默认值为en-us。zh-cn(中文)/en-us(英文)","in":"header","name":"X-Language","required":true,"type":"string"},{"description":"**参数解释:**\n租户token,用于身份验证,通过调用IAM服务获取\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"query","name":"X-Auth-Token","required":false,"type":"string"},{"default":"application/json;charset=utf8","description":"**参数解释:**\n内容类型\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\napplication/json;charset=utf8","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"**参数解释:**\n待删除的告警通知配置列表\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"body","name":"BatchDeleteAlertNoticeConfigBody","required":true,"schema":{"$ref":"#/definitions/BatchDeleteAlertNoticeConfigBody"}}],"produces":["application/json"],"responses":{"200":{"description":"请求成功","examples":{"application/json":{"alert_notice_configs":[{"id":"alert_notice_configs_id"}]}},"schema":{"$ref":"#/definitions/AlertNoticeConfigList"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"批量删除告警通知","tags":["告警管理"],"x-api-type":"open-api","x-is-registered":"Y","x-request-examples-description-1":"批量删除告警通知","x-request-examples-text-1":{"alert_notice_configs":[{"id":"alert_notice_configs_id"}]},"x-request-examples-url-1":"POST https://{endpoint}/v2/{project_id}/waf/alert/batch-delete?enterprise_project_id=0","x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"批量删除告警通知","tags":"告警管理","uri":null,"version":"2.0"}