huawei-cloud-api-definitions-CAE 0.1.20250328

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"ApiVersionObj":{"description":"API版本,固定值“v1”,该值不可修改。","enum":["v1"],"type":"string"},"CreateDomainReq":{"properties":{"api_version":{"$ref":"#/definitions/ApiVersionObj"},"kind":{"$ref":"#/definitions/DomainKindObj"},"metadata":{"$ref":"#/definitions/CreateMetaDomain","description":"请求数据。"}},"required":["api_version","kind","metadata"],"type":"object"},"CreateMetaDomain":{"properties":{"name":{"description":"域名名称。","type":"string"}},"required":["name"],"type":"object"},"DomainInfo":{"properties":{"api_version":{"$ref":"#/definitions/ApiVersionObj"},"items":{"description":"域名列表。","items":{"$ref":"#/definitions/DomainItem"},"type":"array"},"kind":{"description":"API类型,固定值“Domain”,该值不可修改。","type":"string"}},"type":"object"},"DomainItem":{"properties":{"metadata":{"$ref":"#/definitions/MetaDomain","description":"响应数据。","type":"object"}},"type":"object"},"DomainKindObj":{"description":"API类型,固定值“Domain”,该值不可修改。","enum":["Domain"],"type":"string"},"MetaDomain":{"properties":{"created_at":{"description":"创建时间。","format":"date-time","type":"string"},"id":{"description":"域名ID。","type":"string"},"name":{"description":"域名名称。","type":"string","x-api-inputuntrust-envparam":"Env"}},"type":"object"}},"description":null,"group_id":"233de030b8054c65a90cfefe2e0b09aa","host":"cae.cn-north-4.myhuaweicloud.com","id":"aea30e96be42435e92d76852bed39a56","info_version":"v1","method":"post","name":"CreateDomain","parameters":{"param_header_x_auth_token":{"description":"用户Token。    \n- 获取Token,请参考《[统一身份认证服务API参考](https://support.huaweicloud.com/api-iam/iam_30_0001.html)》的“获取用户Token”章节。          \n- 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","maxLength":16384,"name":"X-Auth-Token","required":true,"type":"string","x-order":52},"param_header_x_enterprise_project_id":{"description":"企业项目ID。 \n- 创建环境时,环境会绑定企业项目ID。     \n- 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。    \n- 该字段不传(或传为字符串“0”)时,则查询默认企业项目下的资源。\n\n> 关于企业项目ID的获取及企业项目特性的详细信息,请参见《[企业管理服务用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)》。","in":"header","name":"X-Enterprise-Project-ID","pattern":"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$|^0$","required":false,"type":"string","x-order":53},"param_header_x_environment_id":{"description":"环境ID。     \n- 获取环境ID,通过《[云应用引擎API参考](https://support.huaweicloud.com/api-cae/ListEnvironments.html)》的“获取环境列表”章节获取环境信息。    \n- 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。","in":"header","name":"X-Environment-ID","pattern":"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$","required":true,"type":"string","x-order":54},"param_path_project_id":{"description":"项目ID,获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-cae/cae_06_0021.html)。","in":"path","name":"project_id","required":true,"type":"string","x-order":1,"x-sec-authority-parameter":"Y"}},"paths":{"/v1/{project_id}/cae/domains":{"post":{"consumes":["application/json"],"description":"创建域名。","operationId":"CreateDomain","parameters":[{"$ref":"#/parameters/param_path_project_id"},{"$ref":"#/parameters/param_header_x_auth_token"},{"$ref":"#/parameters/param_header_x_enterprise_project_id"},{"$ref":"#/parameters/param_header_x_environment_id"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CreateDomainReq"}}],"produces":["application/json"],"responses":{"200":{"description":"请求成功。","examples":{"application/json":"{\n \"api_version\": \"v1\",\n \"kind\": \"Domain\",\n \"items\": [\n  {\n   \"metadata\": {\n    \"id\": \"4475ba56-7669-4af8-8707-c9b1368c3f9c\",\n    \"name\": \"example.cn\",\n    \"created_at\": \"2022-12-30T08:33:35.140718Z\"\n   }\n  }\n ]\n}"},"schema":{"$ref":"#/definitions/DomainInfo"}}},"summary":"创建域名","tags":["Domain"],"x-api-framework":"RestfulAPI","x-api-position":"Region_ZONE","x-api-type":"open-api","x-api-user":"IAM_User","x-api-userinput-untrust":{"EnvParam":"name"},"x-apiexplorer-hide":"false","x-authority-parameter-url":"project_id","x-is-registered":"Y","x-open-region-cloud":"hws,hws_eu,hws_hk","x-request-examples-1":{"api_version":"v1","kind":"Domain","metadata":{"name":"example.cn"}},"x-request-examples-description-1":"创建域名,域名为“example.cn”。","x-request-examples-url-1":"POST https://{endpoint}/v1/{project_id}/cae/domains","x-sec-auditlog":"N","x-sec-privacy-datalevel":"L3","x-sec-upload-download":"N","x-support-sdk":"Y"}}},"product_short":"CAE","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建域名","tags":"域名","uri":null,"version":"2.0"}