huawei-cloud-api-definitions-WAF 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"AttackTypeClassificationItem":{"properties":{"items":{"description":"AttackTypeItem详细信息","items":{"$ref":"#/definitions/AttackTypeItem"},"type":"array"},"total":{"description":"AttackTypeItem的总数量","type":"integer"}}},"AttackTypeItem":{"description":"攻击事件分布统计","properties":{"key":{"description":"攻击事件类型","type":"string"},"num":{"description":"数量","type":"integer"}},"type":"object"},"DomainClassificationItem":{"properties":{"items":{"description":"DomainItem详细信息","items":{"$ref":"#/definitions/DomainItem"},"type":"array"},"total":{"description":"DomainItem的总数量","type":"integer"}}},"DomainItem":{"description":"受攻击域名统计","properties":{"key":{"description":"域名","type":"string"},"num":{"description":"数量","type":"integer"},"web_tag":{"description":"网站名称,对应WAF控制台域名详情中的网站名称","type":"string"}},"type":"object"},"GeoClassificationItem":{"properties":{"items":{"description":"GeoItem详细信息","items":{"$ref":"#/definitions/GeoItem"},"type":"array"},"total":{"description":"GeoItem的总数量","type":"integer"}}},"GeoItem":{"description":"攻击来源区域统计","properties":{"key":{"description":"攻击来源区域","type":"string"},"num":{"description":"数量","type":"integer"}},"type":"object"},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"IpClassificationItem":{"properties":{"items":{"description":"IpItem详细信息","items":{"$ref":"#/definitions/IpItem"},"type":"array"},"total":{"description":"IpItem的总数量","type":"integer"}}},"IpItem":{"description":"攻击源Ip","properties":{"key":{"description":"ip地址","type":"string"},"num":{"description":"数量","type":"integer"}},"type":"object"},"ListClassificationResponseBody":{"description":"返回分类统计数据:受攻击域名、攻击源ip、受攻击url、攻击来源区域、攻击事件分布","properties":{"attack_type":{"$ref":"#/definitions/AttackTypeClassificationItem","description":"攻击事件分布"},"domain":{"$ref":"#/definitions/DomainClassificationItem","description":"受攻击域名"},"geo":{"$ref":"#/definitions/GeoClassificationItem","description":"攻击来源区域"},"ip":{"$ref":"#/definitions/IpClassificationItem","description":"攻击源ip"},"url":{"$ref":"#/definitions/UrlClassificationItem","description":"受攻击url"}}},"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"},"UrlClassificationItem":{"properties":{"items":{"description":"UrlItem详细信息","items":{"$ref":"#/definitions/UrlItem"},"type":"array"},"total":{"description":"UrlItem的总数量","type":"integer"}}},"UrlItem":{"description":"受攻击URL统计","properties":{"host":{"description":"域名","type":"string"},"key":{"description":"url路径","type":"string"},"num":{"description":"数量","type":"integer"}},"type":"object"}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"5b8102c266d84cc5a8474b113e661b62","info_version":"v1","method":"get","name":"ListOverviewsClassification","parameters":{},"paths":{"/v1/{project_id}/waf/overviews/classification":{"get":{"description":"查询安全总览分类统计TOP信息,包含受攻击域名 、攻击源ip、受攻击URL、攻击来源区域、攻击事件分布。","operationId":"ListOverviewsClassification","parameters":[{"description":"用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"default":"application/json;charset=utf8","description":"内容类型","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"语言,默认值为en-us。zh-cn(中文)/en-us(英文)","in":"header","name":"X-Language","required":false,"type":"string"},{"description":"项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID","in":"path","name":"project_id","required":true,"type":"string"},{"description":"您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"description":"起始时间(13位毫秒时间戳),需要和to同时使用","format":"int64","in":"query","name":"from","required":true,"type":"integer"},{"description":"结束时间(13位毫秒时间戳),需要和from同时使用","format":"int64","in":"query","name":"to","required":true,"type":"integer"},{"description":"要查询的前几的结果,最大值为10,默认值为5。","in":"query","name":"top","required":false,"type":"integer"},{"description":"域名id,通过查询云模式防护域名列表(ListHost)获取域名id或者通过独享模式域名列表(ListPremiumHost)获取域名id。默认不传,查询该项目下所有防护域名的top业务异常统计信息。","in":"query","name":"hosts","type":"string"},{"description":"要查询引擎实例id","in":"query","name":"instances","required":false,"type":"string"}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"ok","examples":{"application/json":{"attack_type":{"items":[{"key":"custom_custom","num":2}],"total":1},"domain":{"items":[{"key":"www.whitelist.com","num":2,"web_tag":"www.whitelist.com"},{"key":"zbx002.apayaduo.cn","num":2,"web_tag":""}],"total":2},"geo":{"items":[{"key":"上海","num":2}],"total":1},"ip":{"items":[{"key":"10.142.4.15","num":2}],"total":1},"url":{"items":[{"host":"www.whitelist.com","key":"/attack","num":2}],"total":1}}},"schema":{"$ref":"#/definitions/ListClassificationResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"查询安全总览分类统计top信息","tags":["安全总览"],"x-is-registered":"Y","x-request-examples-description-1":"查询项目id为project_id,时间从2022-05-19 00:00:00到2022-06-17 11:14:41,域名id为“1bac09440a814aa98ed08302c580a48b”,引擎实例id为“5a532f83a2fb476ba51ca1de7b1ebc43”的top10安全总览分类统计信息","x-request-examples-url-1":"GET https://{Endpoint}/v1/{project_id}/waf/overviews/classification?enterprise_project_id=0&from=1652889600354&to=1655435681354&top=10&hosts=1bac09440a814aa98ed08302c580a48b&hosts=5a532f83a2fb476ba51ca1de7b1ebc43","x-support-international":true,"x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询安全总览分类统计top信息","tags":"安全总览","uri":null,"version":"2.0"}