huawei-cloud-api-definitions-WAF 0.1.20260403

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"BindHost":{"description":"绑定的域名信息","properties":{"hostname":{"description":"域名","type":"string"},"id":{"description":"域名ID","type":"string"},"mode":{"description":"仅独享模式涉及特殊域名模式","type":"string"},"waf_type":{"description":"域名对应模式:cloud(云模式)/premium(独享模式)","type":"string"}}},"CreateCertificateRequestBody":{"properties":{"content":{"description":"证书文件,仅支持PEM格式的证书和私钥文件,且文件中的换行符应以\\n替换,如请求示例所示","type":"string"},"key":{"description":"证书私钥,仅支持PEM格式的证书和私钥文件,且文件中的换行符应以\\n替换,如请求示例所示","type":"string"},"name":{"description":"证书名称,证书名称只能由数字、字母、中划线、下划线和英文句点组成,长度不能超过256位字符","type":"string"}},"required":["name","content","key"]},"CreateCertificateResponseBody":{"properties":{"bind_host":{"description":"证书关联的域名信息","items":{"$ref":"#/definitions/BindHost"},"type":"array"},"content":{"description":"证书文件,PEM编码","type":"string"},"exp_status":{"description":"**参数解释:**\n证书过期状态\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:未过期\n - 1:已过期\n - 2:即将过期(证书将在一个月内过期)\n\n**默认取值:**\n不涉及","enum":[0,1,2],"type":"integer"},"expire_time":{"description":"证书过期时间戳","format":"int64","type":"integer"},"id":{"description":"证书ID","type":"string"},"key":{"description":"证书私钥,PEM编码","type":"string"},"name":{"description":"证书名","type":"string"},"timestamp":{"description":"证书上传时间戳","format":"int64","type":"integer"}},"required":["id","name","timestamp"]},"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":"5987d3ca35ae4b7bb953224665ee9f87","info_version":"v1","method":"post","name":"CreateCertificate","parameters":{},"paths":{"/v1/{project_id}/waf/certificate":{"post":{"description":"创建证书","operationId":"CreateCertificate","parameters":[{"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":"内容类型","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID","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\n**默认取值:**\n0","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"default":false,"description":"是否验证证书和私钥,true为验证,false为不验证","in":"query","name":"verify_cert_key","required":false,"type":"boolean"},{"description":"requestBody","in":"body","name":"CreateCertificateRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateCertificateRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"expire_time":1682394560000,"id":"64af92e2087d49cbabc233e9bdc761b7","name":"testly","timestamp":1658994431596}},"schema":{"$ref":"#/definitions/CreateCertificateResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"创建证书","tags":["证书管理"],"x-hybridcloud":true,"x-is-registered":"Y","x-request-examples-1":{"content":"-----BEGIN CERTIFICATE----- \\n******\\n -----END CERTIFICATE-----","key":"-----BEGIN PRIVATE KEY----- \\n*******\\n -----END PRIVATE KEY-----","name":"demo"},"x-request-examples-description-1":"在项目id为project_id的项目中创建证书,证书名称为 \"demo\",证书内容为 \"-----BEGIN CERTIFICATE----- ......“,证书密钥为\"-----BEGIN PRIVATE KEY-----......”。","x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/waf/certificate?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"}