huawei-cloud-api-definitions-ROMA 0.1.20240626

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"CertForm":{"description":"添加或编辑证书的请求体表单","properties":{"cert_content":{"description":"证书内容","example":"-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----","type":"string"},"instance_id":{"description":"所属实例ID,当type=instance时必填","example":"f0fa1789-3b76-433b-a787-9892951c620e","type":"string"},"name":{"description":"证书名称。长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、下划线组成,且只能以英文或中文开头。","example":"cert_demo","type":"string"},"private_key":{"description":"证书私钥","example":"-----BEGIN RSA PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END RSA PRIVATE KEY-----","type":"string"},"trusted_root_ca":{"description":"信任的根证书CA","example":"-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----","type":"string"},"type":{"default":"global","description":"证书可见范围","enum":["instance","global"],"example":"instance","type":"string"}},"required":["name","cert_content","private_key"]},"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]},"SslInfo":{"properties":{"algorithm_type":{"description":"证书算法类型:\n- RSA\n- ECC\n- SM2","enum":["RSA","ECC","SM2"],"example":"RSA","type":"string"},"ssl_id":{"description":"SSL证书编号","example":"ddsa83b07744e8eb1872d695ed4743b","type":"string"},"ssl_name":{"description":"SSL证书名称","example":"certificate","type":"string"},"type":{"default":"global","description":"证书可见范围:\n- instance:当前实例\n- global:全局","enum":["instance","global"],"example":"instance","type":"string"}}},"UrlDomainBaseInfo":{"properties":{"id":{"description":"自定义域名的编号","example":"b9be707660c5406394f8973e087bae20","type":"string"},"is_http_redirect_to_https":{"default":false,"description":"是否开启http到https的重定向,false为关闭,true为开启,默认为false","example":true,"type":"boolean"},"min_ssl_version":{"description":"支持的最小SSL版本","example":"TLSv1.1","type":"string"},"status":{"description":"CNAME解析状态\n- 1: 未解析\n- 2: 解析中\n- 3: 解析成功\n- 4: 解析失败","enum":[1,2,3,4],"example":3,"format":"int32","type":"integer"},"url_domain":{"description":"自定义域名","example":"www.example.com","type":"string"},"verified_client_certificate_enabled":{"default":false,"description":"是否开启客户端证书校验。只有绑定证书时,该参数才生效。当绑定证书存在trusted_root_ca时,默认开启;当绑定证书不存在trusted_root_ca时,默认关闭。","example":false,"type":"boolean"}},"required":["id","url_domain","status","min_ssl_version"]},"UrlDomainCertInfo":{"allOf":[{"$ref":"#/definitions/UrlDomainBaseInfo"},{"properties":{"ssl_id":{"description":"证书的编号","example":"0a515af69f4e4dcca84fbf85f68c0e27","type":"string"},"ssl_infos":{"description":"SSL证书列表","items":{"$ref":"#/definitions/SslInfo"},"type":"array"},"ssl_name":{"description":"证书的名称","example":"证书","type":"string"}},"type":"object"}],"required":["ssl_id","ssl_name"]}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"d80f7ce8c6484caf803ec07c5718a52e","info_version":"v2","method":"post","name":"AssociateCertificateV2","parameters":{"apic_domain_id":{"description":"域名的编号","in":"path","name":"domain_id","required":true,"type":"string","x-example":"f6bb84ccf1c34035878aa51b7253b21c"},"apic_group_id":{"description":"分组的编号","in":"path","name":"group_id","required":true,"type":"string","x-example":"c77f5e81d9cb4424bf704ef2b0ac7600"},"apic_instance_id":{"description":"实例ID","in":"path","name":"instance_id","required":true,"type":"string","x-example":"f0fa1789-3b76-433b-a787-9892951c620e"},"apic_project_id":{"description":"项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。","in":"path","name":"project_id","required":true,"type":"string","x-example":"73d69ae0cfcf460190522d06b60f05ad"},"apic_x_auth_token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."}},"paths":{"/v2/{project_id}/apic/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate":{"post":{"description":"如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。\n本章节主要介绍为特定域名绑定证书。","operationId":"AssociateCertificateV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"$ref":"#/parameters/apic_group_id"},{"$ref":"#/parameters/apic_domain_id"},{"description":"绑定域名证书的请求体","in":"body","name":"AssociateCertificateV2RequestBody","required":true,"schema":{"$ref":"#/definitions/CertForm"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"id":" f6bb84ccf1c34035878aa51b7253b21c","ssl_id":"a27be832f2e9441c8127fe48e3b5ac67","ssl_name":"cert_demo","status":3,"url_domain":"www.example.com"}},"schema":{"$ref":"#/definitions/UrlDomainCertInfo"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2012","error_msg":"Invalid parameter value,parameterName:name. Please refer to the support documentation"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"APIG.1002","error_msg":"Incorrect token or token resolution failed"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"APIG.1005","error_msg":"No permissions to request this method"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"404":{"description":"Not Found","examples":{"application/json":{"error_code":"APIG.3020","error_msg":"The URL domain does not exist"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"APIG.9999","error_msg":"System error"}},"schema":{"$ref":"#/definitions/ResponseModel"}}},"schemes":["https"],"summary":"绑定域名证书","tags":["域名管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":2,"x-request-examples-1":{"cert_content":"-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----","name":"cert_demo","private_key":"-----BEGIN PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END PRIVATE KEY-----"},"x-request-examples-description-1":"为已绑定的域名添加域名证书,证书可见范围为全局可见","x-romaconnect-mode":"huaweicloud,hybrid,on-premise","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"绑定域名证书","tags":"域名管理","uri":null,"version":"2.0"}