huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"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"},"StatisticsTimeline":{"description":"**参数解释:**\n安全统计的时间线,按时间顺序展示统计数据\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","items":{"$ref":"#/definitions/StatisticsTimelineItem"},"type":"array"},"StatisticsTimelineItem":{"description":"不同键值对应的时间线","example":[{"key":"ACCESS","timeline":[{"num":15820,"time":1714521600000},{"num":16358,"time":1714525200000},{"num":14982,"time":1714528800000},{"num":13650,"time":1714532400000}]},{"key":"CRAWLER","timeline":[{"num":235,"time":1714521600000},{"num":189,"time":1714525200000},{"num":212,"time":1714528800000},{"num":156,"time":1714532400000}]}],"properties":{"key":{"description":"键值,包括请求总量(ACCESS)、Bot攻击防护(CRAWLER)、攻击总量(ATTACK)、Web基础防护(WEB_ATTACK)、精准防护(PRECISE)、CC攻击防护(CC)","type":"string"},"timeline":{"description":"对应键值的时间线统计数据","items":{"$ref":"#/definitions/TimeLineItem"},"type":"array"}},"type":"object"},"TimeLineItem":{"properties":{"num":{"description":"数量","type":"integer"},"time":{"description":"时间点","format":"int64","type":"integer"}},"title":"CountItem","type":"object"}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"b0e28241e6d040cd9d402a9df5dd63cf","info_version":"v1","method":"get","name":"ListResponseCodeTimeline","parameters":{},"paths":{"/v1/{project_id}/waf/overviews/response-code/timeline":{"get":{"description":"查询安全统计响应码数据","operationId":"ListResponseCodeTimeline","parameters":[{"description":"**参数解释:**\n用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"header","name":"X-Auth-Token","required":true,"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项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。\n**约束限制:**\n不涉及\n**取值范围:**\n只能由英文字母、数字组成,且长度为32个字符。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"description":"**参数解释:**\n您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:代表default企业项目\n - all_granted_eps:代表所有企业项目\n - 其它企业项目ID:长度为36个字符\n**默认取值:**\n0","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"description":"**参数解释:**\n起始时间(13位毫秒时间戳)\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","format":"int64","in":"query","name":"from","required":true,"type":"integer"},{"description":"**参数解释:**\n结束时间(13位毫秒时间戳)\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","format":"int64","in":"query","name":"to","required":true,"type":"integer"},{"description":"**参数解释:**\n要查询的域名列表,通过 ”查询独享模式域名列表“(ListPremiumHost)或者 “查询云模式防护域名列表” (ListHost)接口获取\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"query","items":{"type":"string"},"name":"hosts","required":false,"type":"array"},{"description":"**参数解释:**\n要查询的实例列表,通过 “查询WAF独享引擎列表”(ListInstance)接口获取\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"query","items":{"type":"string"},"name":"instances","required":false,"type":"array"},{"description":"**参数解释:**\n响应源\n**约束限制:**\n不涉及\n**取值范围:**\n- WAF\n- UPSTREAM\n\n**默认取值:**\n不涉及","enum":["WAF","UPSTREAM"],"in":"query","name":"response_source","required":false,"type":"string"},{"description":"**参数解释:**\n展示维度,按天展示时传\"DAY\"\n**约束限制:**\n不涉及\n**取值范围:**\n- DAY\n\n**默认取值:**\n不涉及","in":"query","name":"group_by","required":false,"type":"string"}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"ok","examples":{"application/json":[{"key":"ACCESS","timeline":[{"num":15820,"time":1714521600000},{"num":16358,"time":1714525200000},{"num":14982,"time":1714528800000},{"num":13650,"time":1714532400000}]}]},"schema":{"$ref":"#/definitions/StatisticsTimeline"}},"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-support-international":true,"x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询安全统计响应码数据","tags":"安全总览","uri":null,"version":"2.0"}