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":{"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"]},"NeutronListNetworksResponseBody":{"description":"","properties":{"networks":{"description":"network对象列表","items":{"$ref":"#/definitions/NeutronNetwork"},"type":"array","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"},"networks_links":{"description":"分页信息","items":{"$ref":"#/definitions/NeutronPageLink","description":""},"type":"array","x-admin":"False","x-huawei-extraAnnotation":"","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,obc"}},"required":["networks"]},"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"]},"NeutronPageLink":{"description":"","properties":{"href":{"description":"API链接","example":"https://vpc.cn-north-1.myhuaweicloud.com/v2.0","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"},"rel":{"description":"API链接与该API版本的关系","example":"self","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc"}},"required":["href","rel"]}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"be9dd39a853a4dcfbc29629c1aaaed7f","info_version":"v2","method":"get","name":"NeutronListNetworks","parameters":{},"paths":{"/v2.0/networks":{"get":{"consumes":[],"deprecated":false,"description":"查询提交请求的租户的所有网络,单次查询最多返回2000条数据,超过2000后会返回分页标记。分页查询请参考分页查询。","operationId":"NeutronListNetworks","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},{"default":2000,"description":"每页返回的个数","format":"int32","in":"query","name":"limit","required":false,"type":"integer","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":2},{"description":"分页查询起始的资源ID,为空时查询第一页","in":"query","name":"marker","pattern":"[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}","required":false,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":3},{"description":"按照网络对应的ID过滤查询","in":"query","name":"id","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}","required":false,"type":"string","x-admin":"False","x-example":"053b3abe-2ff4-4192-bf08-4b239210b847","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":4},{"description":"按照网络的名称过滤查询","in":"query","name":"name","required":false,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":5},{"description":"按照网络的状态过滤查询,取值范围:ACTIVE、ERROR、DOWN","in":"query","name":"status","required":false,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":6},{"description":"按照网络是否支持跨租户共享过滤查询,取值范围:true or false","in":"query","name":"shared","required":false,"type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":7},{"description":"按照网络是否外部网络过滤查询,取值范围:true or false","in":"query","name":"router:external","required":false,"type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":8},{"description":"按照网络的管理状态过滤查询,取值范围:true or false","in":"query","name":"admin_state_up","required":false,"type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":9},{"default":"N/A","description":"按照网络的类型过滤查询","in":"query","name":"provider:network_type","required":false,"type":"string","x-admin":"False","x-example":"?provider:network_type=vxlan","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":10},{"description":"按照network所属的项目ID过滤","in":"query","name":"tenant_id","required":false,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc","x-order":11}],"produces":[],"responses":{"200":{"description":"正常返回","examples":{"application/json":{"networks":[{"admin_state_up":true,"availability_zone_hints":[],"availability_zones":["az1.dc1","kvmxen.dc1","dc2","ceshishouqing"],"created_at":"2019-04-02T07:57:00","dns_domain":"southchina.compute.internal.","id":"053b3abe-2ff4-4192-bf08-4b239210b847","name":"test","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-02T07:57:00"}]}},"schema":{"$ref":"#/definitions/NeutronListNetworksResponseBody"}},"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":82,"x-publishpath":"","x-request-examples-1":"GET https://{Endpoint}/v2.0/networks?name=test&shared=false&status=ACTIVE&provider:network_type=vxlan&admin_state_up=true","x-request-examples-2":"GET https://{Endpoint}/v2.0/networks?router:external=true","x-request-examples-3":"GET https://{Endpoint}/v2.0/networks?id=10b932da-f95c-4003-a77d-4064b7d101cd","x-request-examples-4":"GET https://{Endpoint}/v2.0/networks?limit=1","x-request-examples-5":"GET https://{Endpoint}/v2.0/networks?limit=10&marker=10b932da-f95c-4003-a77d-4064b7d101cd","x-request-examples-description-1":"使用组合参数过滤查询结果","x-request-examples-description-2":"使用router:external过滤查询结果,可以用来查询外部网络","x-request-examples-description-3":"使用network对应的id过滤查询结果","x-request-examples-description-4":"分页过滤查询结果,每页返回的个数","x-request-examples-description-5":"分页过滤查询结果,每页返回limit个数据,从第marker数据之后返回","x-request-examples-text-1":"GET https://{Endpoint}/v2.0/networks?name=test&shared=false&status=ACTIVE&provider:network_type=vxlan&admin_state_up=true","x-request-examples-text-2":"GET https://{Endpoint}/v2.0/networks?router:external=true","x-request-examples-text-3":"GET https://{Endpoint}/v2.0/networks?id=10b932da-f95c-4003-a77d-4064b7d101cd","x-request-examples-text-4":"GET https://{Endpoint}/v2.0/networks?limit=1","x-request-examples-text-5":"GET https://{Endpoint}/v2.0/networks?limit=10&marker=10b932da-f95c-4003-a77d-4064b7d101cd","x-request-examples-url-1":"","x-request-examples-url-2":"","x-request-examples-url-3":"","x-request-examples-url-4":"","x-request-examples-url-5":"","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"}