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":{"ExternalGatewayInfo":{"description":"","properties":{"enable_snat":{"description":"功能说明:是否启用SNAT\n取值范围:true、false;默认为false。","type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"network_id":{"description":"外部网络的ID。","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"}}},"ExternalGatewayInfoOption":{"description":"","properties":{"network_id":{"description":"外部网络的ID。\n外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。","type":"string","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"}}},"NeutronCreateRouterOption":{"description":"","properties":{"admin_state_up":{"default":true,"description":"功能说明:资源的管理状态\n取值范围:true、false\n约束:只支持true","type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"external_gateway_info":{"$ref":"#/definitions/ExternalGatewayInfoOption","description":"功能说明:路由器的外部网关信息,见ExternalGatewayInfo对象详情\n约束:当前只有DT开放该字段,vpc.shared.snat开关为true时才能设置","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约束:如果name非空,则name不能重复","maxLength":64,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"}}},"NeutronCreateRouterRequestBody":{"description":"","properties":{"router":{"$ref":"#/definitions/NeutronCreateRouterOption","description":"router对象","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["router"]},"NeutronErrorBody":{"description":"","properties":{"detail":{"description":"错误请求返回的错误详情","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"},"message":{"description":"错误请求返回的错误信息","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"},"type":{"description":"错误请求返回的错误类型","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["detail","message","type"]},"NeutronErrorResponseBody":{"description":"","properties":{"NeutronError":{"$ref":"#/definitions/NeutronErrorBody","description":"错误信息返回体","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["NeutronError"]},"NeutronRouter":{"description":"router对象模型","properties":{"admin_state_up":{"description":"功能说明:资源的管理状态。只支持true。\n取值范围:true、false\n约束:只支持true","type":"boolean","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"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,sbc"},"external_gateway_info":{"$ref":"#/definitions/ExternalGatewayInfo","description":"功能说明:路由器的外部网关信息,见ExternalGatewayInfo对象详情\n约束:当前只有DT开放该字段,vpc.shared.snat开关为true时才能设置","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"id":{"description":"路由器ID","type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"name":{"description":"功能说明:路由器的名称\n取值范围:0-64个字符,仅支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。\n约束:如果name非空,则name不能重复。","maxLength":64,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"project_id":{"description":"项目ID","maxLength":64,"type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"routes":{"description":"功能说明:路由信息,见Route对象","items":{"$ref":"#/definitions/Route"},"type":"array","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"status":{"description":"功能说明:路由器的状态\n取值范围:ACTIVE, DOWN,ERROR","type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"tenant_id":{"description":"项目ID","maxLength":255,"minLength":32,"type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"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,sbc"}},"required":["admin_state_up","created_at","external_gateway_info","id","name","project_id","routes","status","tenant_id","updated_at"]},"NeutronRouterResponseBody":{"description":"","properties":{"router":{"$ref":"#/definitions/NeutronRouter","description":"router对象","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["router"]},"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"}}}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"1632e0deaff24e5a80fbf7cc1774a5d0","info_version":"v2","method":"post","name":"NeutronCreateRouter","parameters":{},"paths":{"/v2.0/routers":{"post":{"consumes":[],"deprecated":false,"description":"创建路由器。","operationId":"NeutronCreateRouter","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":"路由器对象","in":"body","name":"router","required":true,"schema":{"$ref":"#/definitions/NeutronCreateRouterRequestBody"},"x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc","x-order":2}],"produces":[],"responses":{"201":{"description":"正常返回","examples":{"application/json":{"router":{"admin_state_up":true,"external_gateway_info":{"enable_snat":false,"network_id":"0a2228f2-7f8a-45f1-8e09-9039e1d09975"},"id":"f5dbdfe0-86f9-4b0a-9a32-6be143f0a076","name":"router-test2","routes":[],"status":"ACTIVE","tenant_id":"bbfe8c41dd034a07bebd592bf03b4b0c"}}},"schema":{"$ref":"#/definitions/NeutronRouterResponseBody"}},"400":{"description":"服务器未能处理请求。","schema":{"$ref":"#/definitions/NeutronErrorResponseBody"}},"401":{"description":"被请求的页面需要用户名和密码。","schema":{"$ref":"#/definitions/NeutronErrorResponseBody"}},"403":{"description":"对被请求页面的访问被禁止。","schema":{"$ref":"#/definitions/NeutronErrorResponseBody"}},"404":{"description":"服务器无法找到被请求的页面。","schema":{"$ref":"#/definitions/NeutronErrorResponseBody"}},"409":{"description":"由于冲突,请求无法被完成。","schema":{"$ref":"#/definitions/NeutronErrorResponseBody"}},"500":{"description":"请求未完成。服务异常","schema":{"$ref":"#/definitions/NeutronErrorResponseBody"}}},"summary":"创建路由器","tags":["OpenStack - 路由器"],"x-apiexplorer-hide":"false","x-constraint":"","x-first-open-time":"2016-6-30","x-hybridcloud":"true","x-is-registered":"Y","x-name":"创建路由器","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc","x-order":94,"x-publishpath":"","x-request-examples-1":{"router":{"admin_state_up":true,"name":"router-test2"}},"x-request-examples-description-1":"","x-request-examples-text-1":"{\n\t\"router\": {\n\t\t\"name\": \"router-test2\",\n\t\t\"admin_state_up\": true\n\t}\n}","x-request-examples-url-1":"POST https://{Endpoint}/v2.0/routers","x-scope":"Commercial","x-source":"Native","x-support-sdk":"Y","x-version":"v2.0"}}},"product_short":"VPC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建路由器","tags":"OpenStack - 路由器","uri":null,"version":"2.0"}