huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"CreateCloudWafPostPaidResourceRequestbody":{"description":"开通云模式按需请求体","properties":{"console_area":{"description":"租户所在的站点\n- hec-hk:华为云国际站\n- hws:华为云大陆站","example":"hws","type":"string"}},"required":["console_area"],"type":"object"},"CreateCloudWafPostPaidResourceResponsebody":{"description":"订购信息响应体","properties":{"isNewUser":{"description":"是否为新用户","type":"boolean"},"resources":{"description":"资源列表","items":{"$ref":"#/definitions/ResourceResponse"},"type":"array"},"type":{"description":"云模式版本 \n - -2:已冻结 \n - -1:未订购 \n - 2:标准版 \n - 3:专业版 \n - 4:企业版 \n - 7: 入门版 \n - 22:按需版本","type":"integer"}}},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"ResourceResponse":{"description":"资源信息","properties":{"cloudServiceType":{"description":"**参数解释:**\n云服务产品对应的云服务类型\n**取值范围:**\n不涉及","type":"string"},"expireTime":{"description":"**参数解释:**\n资源到期时间\n**取值范围:**\n不涉及","type":"string"},"region":{"description":"**参数解释:**\n华为云区域ID,资源所属的区域id\n**取值范围:**\n不涉及","type":"string"},"relativeType":{"description":"**参数解释:**\n当资源项为附属资源(域名扩展包/带宽扩展包/规则扩展包/高阶功能扩展包),描述附属资源与主资源的关系\n**取值范围:**\n - 0:附属资源与主资源为挂载关系\n - 1:附属资源与主资源为绑定关系\n - 2:从属关系","type":"integer"},"resourceId":{"description":"**参数解释:**\n资源id\n**取值范围:**\n不涉及","type":"string"},"resourceSize":{"description":"**参数解释:**\n资源数量\n**取值范围:**\n不涉及","type":"integer"},"resourceSpecCode":{"description":"**参数解释:**\n云服务产品的资源规格\n**取值范围:**\n不涉及","type":"string"},"resourceType":{"description":"**参数解释:**\n云服务产品的资源类型\n**取值范围:**\n - hws.resource.type.waf:云模式包周期WAF\n - hws.resource.type.waf.domain:云模式包周期WAF域名扩展包\n - hws.resource.type.waf.bandwidth:云模式包周期WAF带宽扩展包\n - hws.resource.type.waf.rule:云模式包周期WAF规则扩展包\n - hws.resource.type.waf.payperuserequest:Web应用防火墙按需请求 \n - hws.resource.type.waf.payperusedomain:Web应用防火墙按需域名\n - hws.resource.type.waf.payperuserule:Web应用防火墙按需规则","type":"string"},"status":{"description":"**参数解释:**\n资源状态\n**取值范围:**\n - 0:解冻/正常 \n - 1:冻结 \n - 2:删除","type":"integer"},"timestamp":{"description":"**参数解释:**\n资源创建时间\n**取值范围:**\n不涉及","format":"int64","type":"integer"}}},"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":"93f551a7f73a46eba3d60c09f89c4d86","info_version":"v1","method":"post","name":"CreateCloudWafPostPaidResource","parameters":{},"paths":{"/v1/{project_id}/waf/postpaid":{"post":{"description":"开通云模式按需计费接口","operationId":"CreateCloudWafPostPaidResource","parameters":[{"default":"","description":"**参数解释:**\n用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"header","maxLength":4096,"minLength":32,"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\n**约束限制:**\n华为云支持的局点ID\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"header","name":"region","required":true,"type":"string"},{"description":"**参数解释:**\n项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\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":"请求body","in":"body","name":"CreateCloudWafPostPaidResourceRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateCloudWafPostPaidResourceRequestbody"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"isNewUser":false,"resources":[{"cloudServiceType":"hws.service.type.waf","expireTime":null,"resourceId":"71f5de5f03414225b79be43ee3dc6bae","resourceSize":null,"resourceSpecCode":"waf.payperuse.domain","resourceType":"hws.resource.type.waf.payperusedomain","status":0},{"cloudServiceType":"hws.service.type.waf","expireTime":null,"resourceId":"eb0760007a0b43fd9e445f5ce810f4c4","resourceSize":null,"resourceSpecCode":"waf.payperuse.request","resourceType":"hws.resource.type.waf.payperuserequest","status":0},{"cloudServiceType":"hws.service.type.waf","expireTime":null,"resourceId":"6cae8a4d8074499d8c3bda687d63c4f9","resourceSize":null,"resourceSpecCode":"waf.payperuse.rule","resourceType":"hws.resource.type.waf.payperuserule","status":0}],"type":22}},"schema":{"$ref":"#/definitions/CreateCloudWafPostPaidResourceResponsebody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"开通云模式按需计费接口","tags":["租户订购管理"],"x-constraint":"华北-北京二、华东-青岛、土耳其-伊斯坦布尔以及中东-阿布扎比暂不支持该功能。","x-is-registered":"Y","x-request-examples-1":{"console_area":"hec-hk"},"x-request-examples-description-1":"开通项目id为project_id的云模式按需计费接口,租户所在的站点“华为云国际站”。","x-request-examples-text-1":{"console_area":"hec-hk"},"x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/waf/postpaid?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"}