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":{"CertBase":{"properties":{"algorithm_type":{"description":"证书算法类型:\n- RSA\n- ECC\n- SM2","enum":["RSA","ECC","SM2"],"example":"RSA","type":"string"},"common_name":{"description":"域名","example":"apigtest.xxx.com","type":"string"},"create_time":{"description":"创建时间","example":"2020-01-01T00:00:00Z","format":"date-time","type":"string"},"id":{"description":"证书ID","example":"a27be832f2e9441c8127fe48e3b5ac67","type":"string"},"instance_id":{"description":"实例编码\n\n- `type`为`global`时,缺省为common\n- `type`为`instance`时,为实例编码","example":"f0fa1789-3b76-433b-a787-9892951c620e","type":"string"},"is_has_trusted_root_ca":{"default":false,"description":"是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。","example":false,"type":"boolean"},"name":{"description":"证书名称","example":"cert_demo","type":"string"},"not_after":{"description":"有效期到","example":"2020-10-29T11:15:45Z","format":"date-time","type":"string"},"project_id":{"description":"租户项目编号","example":"73d69ae0cfcf460190522d06b60f05ad","type":"string"},"san":{"description":"san扩展域名","example":["apigtest.xxx.com","*.san.com"],"items":{"type":"string"},"type":"array"},"signature_algorithm":{"description":"签名算法","example":"SHA256-RSA","type":"string"},"type":{"description":"证书类型\n\n- global:全局证书\n- instance:实例证书","enum":["global","instance"],"example":"instance","type":"string"},"update_time":{"description":"更新时间","example":"2020-01-01T00:00:00Z","format":"date-time","type":"string"}}},"CertificateDetailResp":{"allOf":[{"$ref":"#/definitions/CertBase"},{"properties":{"country":{"description":"国家","example":["CN"],"items":{"type":"string"},"type":"array"},"issuer":{"description":"颁发者","example":["SSL Inc"],"items":{"type":"string"},"type":"array"},"locality":{"description":"城市","example":["sz"],"items":{"type":"string"},"type":"array"},"not_before":{"description":"有效期从","example":"2019-10-30T11:15:45Z","format":"date-time","type":"string"},"organization":{"description":"公司、组织","example":["hw"],"items":{"type":"string"},"type":"array"},"organizational_unit":{"description":"部门","example":["IT"],"items":{"type":"string"},"type":"array"},"serial_number":{"description":"序列号","example":"13010","type":"string"},"state":{"description":"省份","example":["gd"],"items":{"type":"string"},"type":"array"},"version":{"description":"版本","example":3,"format":"int32","type":"integer"}},"type":"object"}]},"CertificateForm":{"description":"添加或编辑证书的请求体表单","properties":{"algorithm_type":{"description":"证书算法类型:\n- RSA\n- ECC\n- SM2","enum":["RSA","ECC","SM2"],"example":"RSA","type":"string"},"cert_content":{"description":"证书内容","example":"-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----","type":"string"},"cert_content_sign":{"description":"签名类型证书内容,仅algorithm_type=SM2时必填","maxLength":8092,"type":"string"},"instance_id":{"description":"所属实例ID,当type=instance时必填","example":"f0fa1789-3b76-433b-a787-9892951c620e","type":"string"},"name":{"description":"证书名称","example":"cert_demo","type":"string"},"private_key":{"description":"证书私钥","example":"-----BEGIN RSA PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END RSA PRIVATE KEY-----","type":"string"},"private_key_sign":{"description":"签名类型私钥内容,仅algorithm_type=SM2时必填","maxLength":8092,"type":"string"},"trusted_root_ca":{"description":"信任的根证书CA","example":"-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----","type":"string"},"type":{"default":"global","description":"证书可见范围:\n- instance\n- global\n\n编辑证书时不支持修改为其他可见范围","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"]}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"f301e8b8799c4fd7ad112228561a2e76","info_version":"v2","method":"post","name":"CreateCertificateV2","parameters":{"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/certificates":{"post":{"description":"创建SSL证书","operationId":"CreateCertificateV2","parameters":[{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_x_auth_token"},{"description":"创建SSL证书的请求体","in":"body","name":"CreateCertificateV2RequestBody","required":true,"schema":{"$ref":"#/definitions/CertificateForm"}}],"responses":{"200":{"description":"OK","examples":{"application/json":{"algorithm_type":"RSA","common_name":"apigtest.xxx.com","country":["Country"],"create_time":"2021-08-20T02:03:53Z","id":"a27be832f2e9441c8127fe48e3b5ac67","issuer":["SSL Inc"],"locality":["city"],"name":"cert_demo","not_after":"2031-08-16T06:36:13Z","not_before":"2019-06-01T00:00:00Z","organization":["company"],"organizational_unit":["IT"],"san":["apigtest.xxx.com","*.san.com"],"serial_number":"13010","signature_algorithm":"SHA256-RSA","state":["state"],"update_time":"2021-08-20T02:03:53Z","version":3}},"schema":{"$ref":"#/definitions/CertificateDetailResp"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.3325","error_msg":"The API quota name already exists"}},"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.3030","error_msg":"The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"APIG.9999","error_msg":"System error"}},"schema":{"$ref":"#/definitions/ResponseModel"}}},"summary":"创建SSL证书","tags":["SSL证书管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":5,"x-request-examples-1":{"cert_content":"'-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----'","instance_id":"f0fa1789-3b76-433b-a787-9892951c620e","name":"cert_demo","private_key":"'-----BEGIN PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END PRIVATE KEY-----'","type":"instance"},"x-request-examples-description-1":"创建一个SSL证书,可见范围为实例内可见","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建SSL证书","tags":"SSL证书管理","uri":null,"version":"2.0"}