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":{"NeutronCreateNetworkOption":{"description":"创建network对象","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"},"name":{"description":"功能说明:网络名称\n取值范围:0-255个字符\n约束:不能为admin_external_net","maxLength":255,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"port_security_enabled":{"default":true,"description":"功能说明:端口安全使能标记\n取值范围:true(启用)、false(禁用)\n约束:如果不使能,则network下所有虚机的安全组和dhcp防欺骗不生效","type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"provider:network_type":{"description":"功能说明:扩展属性:网络类型。管理员属性,普通租户不可见,允许 geneve类型租户执行操作。\n取值范围:vxlan, geneve","maxLength":32,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"shared":{"default":false,"description":"功能说明:是否支持跨租户共享\n取值范围:true、false","type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"}}},"NeutronCreateNetworkRequestBody":{"description":"","properties":{"network":{"$ref":"#/definitions/NeutronCreateNetworkOption","description":"network对象","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["network"]},"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"]},"NeutronNetwork":{"description":"network对象列表","properties":{"admin_state_up":{"description":"功能说明:资源的管理状态\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"},"availability_zone_hints":{"description":"功能说明:本网络的候选可用域","items":{"type":"string"},"type":"array","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"availability_zones":{"description":"功能说明:本网络的可用域。\n取值范围:当前region下的可用域","items":{"type":"string"},"type":"array","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"},"dns_domain":{"description":"功能说明:默认内网DNS域地址\n约束:系统自动生成维护,不支持设置和更新","maxLength":255,"minLength":0,"type":"string","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-255个字符","maxLength":255,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"port_security_enabled":{"description":"功能说明:端口安全使能标记\n取值范围:true(启用)、false(禁用)\n约束:如果不使能,则network下所有虚机的安全组和dhcp防欺骗不生效","type":"boolean","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,"minLength":32,"type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"provider:network_type":{"description":"功能说明:扩展属性,网络类型(支持vxlan, geneve)\n取值范围:vxlan,geneve","maxLength":32,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"router:external":{"description":"功能说明:扩展属性,是否外部网络\n取值范围:true、false\n约束:不支持设置和更新","type":"boolean","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"shared":{"description":"功能说明:是否支持跨租户共享此资源\n取值范围:true(共享)、false(非共享)\n约束:不支持设置和更新","type":"boolean","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,BUILD或ERROR","enum":["ACTIVE","DOWN","BUILD","ERROR"],"type":"string","x-admin":"False","x-internal":"False","x-obc":"Y","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc"},"subnets":{"description":"功能说明:网络关联的子网ID列表\n约束:一个network仅支持关联一个 subnet。","items":{"type":"string"},"type":"array","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","availability_zone_hints","availability_zones","created_at","dns_domain","id","name","port_security_enabled","project_id","provider:network_type","router:external","shared","status","subnets","tenant_id","updated_at"]},"NeutronNetworkResponseBody":{"description":"","properties":{"network":{"$ref":"#/definitions/NeutronNetwork","description":"network对象","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["network"]}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"4f14145ff73d4b0ebeb0a20b172ac200","info_version":"v2","method":"post","name":"NeutronCreateNetwork","parameters":{},"paths":{"/v2.0/networks":{"post":{"consumes":[],"deprecated":false,"description":"创建网络","operationId":"NeutronCreateNetwork","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,hcso,sbc,obc","x-order":1},{"description":"创建network对象","in":"body","name":"network","required":true,"schema":{"$ref":"#/definitions/NeutronCreateNetworkRequestBody"},"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":{"network":{"admin_state_up":true,"availability_zone_hints":[],"availability_zones":["az1.dc1","kvmxen.dc1","dc2","ceshishouqing"],"created_at":"2019-04-29T08:22:58","dns_domain":"southchina.compute.internal.","id":"6933326f-9389-4ef8-a1ee-d4bf8fc4e171","name":"","port_security_enabled":true,"project_id":"6e9dfd51d1124e8d8498dce894923a0d","provider:network_type":"vxlan","router:external":false,"shared":false,"status":"ACTIVE","subnets":[],"tenant_id":"6e9dfd51d1124e8d8498dce894923a0d","updated_at":"2019-04-29T08:22:58"}}},"schema":{"$ref":"#/definitions/NeutronNetworkResponseBody"}},"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":84,"x-publishpath":"","x-request-examples-1":{"network":{"admin_state_up":true,"name":"network-test"}},"x-request-examples-description-1":"","x-request-examples-text-1":"{\n\t\"network\": {\n\t\t\"name\": \"network-test\",\n\t\t\"admin_state_up\": true\n\t}\n}","x-request-examples-url-1":"POST https://{Endpoint}/v2.0/networks","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"}