huawei-cloud-api-definitions-VPC 0.1.20250523

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"CreateVpcOption":{"description":"vpc对象","properties":{"cidr":{"description":"功能说明:虚拟私有云下可用子网的范围\n取值范围:\n- 10.0.0.0/8 ~ 10.255.255.240/28\n- 172.16.0.0/12 ~ 172.31.255.240/28\n- 192.168.0.0/16 ~ 192.168.255.240/28\n约束:必须是ipv4 cidr格式,例如:192.168.0.0/16","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"description":{"description":"功能说明:虚拟私有云的描述\n取值范围:0-255个字符,不能包含“<”和“>”。","maxLength":255,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"enterprise_project_id":{"default":"0","description":"功能说明:企业项目ID。创建虚拟私有云时,给虚拟私有云绑定企业项目ID。\n取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。\n默认值:\"0\"","type":"string","x-admin":"False","x-open-region-cloud":"hc,hk"},"name":{"description":"功能说明:虚拟私有云名称\n取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)\n约束:如果名称不为空,则同一个租户下的名称不能重复","maxLength":64,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"tags":{"description":"功能说明:VPC资源标签。创建VPC时,给VPC添加资源标签。\n取值范围:最大10个标签, key:标签名称; value:标签值。\n格式:[key*value],每一个标签的key和value之间用*连接","items":{"description":"","type":"string"},"type":"array","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk"}}},"CreateVpcRequestBody":{"description":"","properties":{"vpc":{"$ref":"#/definitions/CreateVpcOption","description":"vpc对象","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["vpc"]},"ErrorResp":{"description":"http响应码为错误码时的返回体数据模型","properties":{"code":{"description":"请求返回的错误码","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"message":{"description":"请求返回的错误信息","maxLength":999,"minLength":1,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"}},"required":["code","message"]},"Route":{"description":"","properties":{"destination":{"description":"功能说明:路由目的地\n取值范围:IP地址段\n约束:仅支持配置默认路由,且其取值只能是0.0.0.0/0","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"nexthop":{"description":"功能说明:路由下一跳IP地址\n取值范围:ipv4地址格式\n约束:nexthop仅支持所关联的子网范围内IP地址","type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"}}},"Vpc":{"description":"","properties":{"cidr":{"description":"功能说明:虚拟私有云下可用子网的范围\n取值范围:\n- 10.0.0.0/8~10.255.255.240/28\n- 172.16.0.0/12 ~ 172.31.255.240/28\n- 192.168.0.0/16 ~ 192.168.255.240/28\n不指定cidr时,默认值为空\n约束:必须是ipv4 cidr格式,例如:192.168.0.0/16","type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"created_at":{"description":"功能说明:资源创建UTC时间\n格式:yyyy-MM-ddTHH:mm:ss","format":"date-time","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"description":{"description":"功能说明:虚拟私有云的描述\n取值范围:0-255个字符,不能包含“<”和“>”","maxLength":255,"minLength":0,"type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"enterprise_project_id":{"description":"功能说明:企业项目ID。\n取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。","maxLength":36,"type":"string","x-admin":"False"},"id":{"description":"功能说明:虚拟私有云ID\n取值范围:带\"-\"的UUID","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"name":{"description":"功能说明:虚拟私有云名称\n取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)\n约束:如果名称不为空,则同一个租户下的名称不能重复","maxLength":64,"minLength":0,"type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"routes":{"description":"功能说明:路由信息列表,详情参见route对象","items":{"$ref":"#/definitions/Route","description":""},"type":"array","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"status":{"description":"功能说明:虚拟私有云的状态\n取值范围:\n- CREATING:创建中\n- OK:创建成功","enum":["CREATING","OK","ERROR"],"type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"tenant_id":{"description":"项目ID","example":"b433fedb577940bfa59abff86482ed1a","pattern":"[0-9a-fA-F]{32}","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"},"updated_at":{"description":"功能说明:资源更新UTC时间\n格式:yyyy-MM-ddTHH:mm:ss","format":"date-time","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"}},"required":["cidr","created_at","description","enterprise_project_id","id","name","routes","status","tenant_id","updated_at"]},"VpcResponseBody":{"description":"","properties":{"vpc":{"$ref":"#/definitions/Vpc","description":"vpc对象","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"}},"required":["vpc"]}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"cf800493e20f46c3ad6d128f697df5e9","info_version":"v2","method":"post","name":"CreateVpc","parameters":{},"paths":{"/v1/{project_id}/vpcs":{"post":{"consumes":[],"deprecated":false,"description":"创建虚拟私有云。","operationId":"CreateVpc","parameters":[{"description":"用户Token。\n获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc","x-order":1},{"description":"项目ID","in":"path","name":"project_id","pattern":"[0-9a-fA-F]{32}","required":true,"type":"string","x-order":2},{"description":"创建VPC对象","in":"body","name":"vpc","required":true,"schema":{"$ref":"#/definitions/CreateVpcRequestBody"},"x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc","x-order":3}],"produces":[],"responses":{"200":{"description":"正常返回","examples":{"application/json":{"vpc":{"cidr":"192.168.0.0/16","description":"test","enterprise_project_id":"0aad99bc-f5f6-4f78-8404-c598d76b0ed2","id":"99d9d709-8478-4b46-9f3f-2206b1023fd3","name":"vpc","routes":[],"status":"CREATING"}}},"schema":{"$ref":"#/definitions/VpcResponseBody"}},"400":{"description":"服务器未能处理请求。","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"被请求的页面需要用户名和密码。","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"对被请求页面的访问被禁止。","schema":{"$ref":"#/definitions/ErrorResp"}},"404":{"description":"服务器无法找到被请求的页面。","schema":{"$ref":"#/definitions/ErrorResp"}},"409":{"description":"由于冲突,请求无法被完成。","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"请求未完成。服务异常。","schema":{"$ref":"#/definitions/ErrorResp"}}},"summary":"创建VPC","tags":["VPC"],"x-apiexplorer-hide":"false","x-constraint":"","x-first-open-time":"2016-6-30","x-hybridcloud":"true","x-is-registered":"Y","x-name":"创建VPC","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc","x-order":1,"x-publishpath":"","x-request-examples-1":{"vpc":{"cidr":"192.168.0.0/16","description":"test","enterprise_project_id":"0aad99bc-f5f6-4f78-8404-c598d76b0ed2","name":"vpc"}},"x-request-examples-description-1":"","x-request-examples-text-1":"{\n\t\"vpc\": {\n\t\t\"name\": \"vpc\",\n\t\t\"description\": \"test\",\n\t\t\"cidr\": \"192.168.0.0/16\",\n\t\t\"enterprise_project_id\": \"0aad99bc-f5f6-4f78-8404-c598d76b0ed2\"\n\t}\n}","x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/vpcs","x-scope":"Commercial","x-source":"SelfDeveloped","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"VPC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建VPC","tags":"VPC","uri":null,"version":"2.0"}