huawei-cloud-api-definitions-ESW 0.1.20251128

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"Connection":{"properties":{"created_at":{"description":"- 参数解释:二层连接创建时间。\n- 约束限制:UTC时间,格式为yyyy-MM-ddTHH:mm:ss。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","format":"date-time","type":"string"},"fixed_ips":{"description":"- 参数解释:下联面网口主备IP;ESW实例在本端二层子网中占用的主备接口IP。\n- 约束限制:字符串列表,只能设置两个字符串,且每个字符串内容应该是标准IPv4格式;IP必须在二层子网网段范围内。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"[\"1.1.1.1\",\"2.2.2.2\"]","items":{"type":"string"},"type":"array"},"id":{"description":"- 参数解释:二层连接的唯一标识。\n- 约束限制:带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"49bb8306-9b76-4de3-8905-d7a207c8fc54","type":"string"},"instance_id":{"description":"- 参数解释:ESW实例的唯一标识。\n- 约束限制:带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"94e7bf9d-c5a0-40da-9bcb-4407fde1907d","type":"string"},"name":{"description":"- 参数解释:二层连接的名称。\n- 约束限制:\n  - 长度范围为1~64个字符。\n  - 名称由中文、英文字母、数字、下划线(_)、中划线(-)、点(.)组成。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"lisiaa","type":"string"},"project_id":{"description":"- 参数解释:ESW实例所属项目ID。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"b2782e6708b8475c993e6064bc456bf8","type":"string"},"remote_infos":{"description":"- 参数解释:远端隧道信息。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"[{\"segmentation_id\":7788,\"tunnel_ip\":\"3.3.3.3\",\"tunnel_port\":4788,\"tunnel_type\":\"vxlan\"},{\"segmentation_id\":7788,\"tunnel_ip\":\"4.4.4.4\",\"tunnel_port\":4789,\"tunnel_type\":\"vxlan\"}]","items":{"$ref":"#/definitions/RemoteInfosResult"},"type":"array"},"status":{"description":"- 参数解释:二层连接的状态。\n- 约束限制:不涉及。\n- 取值范围:\n  - pending:准备中\n  - connected:已连接\n  - disconnect:未连接\n  - failed:创建失败\n  - abnormal:异常\n- 默认取值:不涉及。","example":"active","type":"string"},"updated_at":{"description":"- 参数解释:二层连接更新时间。\n- 约束限制:UTC时间,格式为yyyy-MM-ddTHH:mm:ss。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","format":"date-time","type":"string"},"virsubnet_id":{"description":"- 参数解释:二层连接关联的二层子网ID。\n- 约束限制:\n  - 需要使用本租户下可操作的子网资源的ID;此值即为子网详情中的“网络ID”参数值。\n  - 带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"67d2ed7f-f895-46df-a119-3378a2077efd","type":"string"},"vpc_id":{"description":"- 参数解释:ESW所在VPC资源ID。\n- 约束限制:\n  - 需要使用本租户下可操作的VPC资源的ID。\n  - 带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"6b933ada-1ea9-4df9-9770-c94d0a646bf2","type":"string"}},"required":["created_at","fixed_ips","id","instance_id","name","project_id","remote_infos","status","updated_at","virsubnet_id","vpc_id"],"type":"object"},"ListConnectionsResponseBody":{"properties":{"connections":{"description":"- 参数解释:查询二层连接列表的响应体。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","items":{"$ref":"#/definitions/Connection"},"type":"array"},"page_info":{"$ref":"#/definitions/PageInfo","description":"- 参数解释:分页信息。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。"},"request_id":{"description":"- 参数解释:请求的唯一标识。\n- 约束限制:UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"}},"required":["connections","page_info","request_id"],"type":"object"},"PageInfo":{"properties":{"current_count":{"description":"- 参数解释:当前页记录总数。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","format":"int32","type":"integer"},"next_marker":{"description":"- 参数解释:当前页的最后一条记录,最后一页时无next_marker字段。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"},"previous_marker":{"description":"- 参数解释:分页查询起始的资源ID,为空时查询第一页。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"}},"required":["current_count","previous_marker"],"type":"object"},"RemoteInfosResult":{"properties":{"segmentation_id":{"description":"- 参数解释:二层连接的隧道号,对应VXLAN网络标识VNI。\n- 约束限制:需与对端VXLAN设置的VNI保持一致。\n- 取值范围:1-16777216。\n- 默认取值:不涉及。","example":11000,"format":"int32","type":"integer"},"tunnel_ip":{"description":"- 参数解释:ESW实例的远端隧道IP。\n- 约束限制:不能与已存在的子网IP冲突。\n- 取值范围:标准的IPv4格式,例:192.168.1.1。\n- 默认取值:不涉及。","type":"string"},"tunnel_port":{"description":"- 参数解释:二层连接的远端隧道端口。\n- 约束限制:不涉及。\n- 取值范围:4789。\n- 默认取值:不涉及。","format":"int32","type":"integer"},"tunnel_type":{"description":"- 参数解释:ESW实例的隧道协议类型。\n- 约束限制:不涉及。\n- 取值范围:vxlan。\n- 默认取值:不涉及。","type":"string"}},"required":["segmentation_id","tunnel_ip","tunnel_port","tunnel_type"],"type":"object"}},"description":null,"group_id":"85bc4f8eac384af6b052b0374dba3eac","host":"esw.cn-north-4.myhuaweicloud.com","id":"0f8815f0b5b742e09b5e4ee84f547ba7","info_version":"v1","method":"get","name":"ListConnectionsAllInstances","parameters":{},"paths":{"/v3/{project_id}/l2cg/connections":{"get":{"description":"当您的二层连接创建成功后,您可以通过调用此接口查询租户所有二层连接信息列表。","operationId":"ListConnectionsAllInstances","parameters":[{"description":"- 参数解释:ESW实例所属项目ID。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"- 参数解释:二层连接资源ID。二层连接创建成功后,会生成一个ID,是二层连接对应的唯一标识。\n- 约束限制:带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"id","required":false,"type":"string"},{"description":"- 参数解释:二层连接的名称。\n- 约束限制:\n  - 长度范围为1~64个字符。\n  - 名称由中文、英文字母、数字、下划线(_)、中划线(-)、点(.)组成。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"name","required":false,"type":"string"},{"description":"- 参数解释:ESW资源ID。ESW创建成功后,会生成一个ESW ID,是ESW对应的唯一标识。\n- 约束限制:带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"instance_id","required":false,"type":"string"},{"description":"- 参数解释:ESW所在VPC资源ID。\n- 约束限制:\n  - 需要使用本租户下可操作的VPC资源的ID。\n  - 带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"vpc_id","required":false,"type":"string"},{"description":"- 参数解释:二层连接关联的二层子网ID。\n- 约束限制:\n  - 需要使用本租户下可操作的子网资源的ID;此值即为子网详情中的“网络ID”参数值。\n  - 带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"virsubnet_id","required":false,"type":"string"},{"description":"- 参数解释:分页查询每页返回的记录个数。\n- 约束限制:limit需要和marker配合使用,详细规则请见marker的参数说明。\n- 取值范围:0~2^31-1。\n- 默认取值:2000。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"- 参数解释:分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。\n- 约束限制:marker需要和limit配合使用。\n  - 若不传入marker和limit参数,查询结果返回第一页全部资源记录。\n  - 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。\n  - 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。\n  - 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11~2000条(limit默认值2000)资源记录。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"marker","required":false,"type":"string"}],"responses":{"200":{"description":"GET操作正常返回,更多状态码请参见[状态码](esw_api0020.xml)。","examples":{"application/json":{"connections":[{"created_at":"2025-06-24T06:09:03Z","fixed_ips":["192.168.1.170","192.168.1.140"],"id":"9cb4f6bd-89a0-4633-b53e-c333b8c9277f","instance_id":"16b2eea7-5935-445d-8410-083b7064b939","name":"l2conn-ba19","project_id":"88104fcc62a640bfa0a0bf687607621c","remote_infos":[{"segmentation_id":6790,"tunnel_ip":"192.168.4.202","tunnel_port":4789,"tunnel_type":"vxlan"}],"status":"disconnect","updated_at":"2025-08-22T02:30:50Z","virsubnet_id":"7ef08d1e-6e82-4133-9147-5dde6a50ee90","vpc_id":"41829b5e-66c0-4928-a3d4-f4570ce81d8f"},{"created_at":"2025-08-22T02:53:04Z","fixed_ips":["192.168.1.158","192.168.1.42"],"id":"d5a0c32d-e52d-48d8-8afb-ee9975618ba3","instance_id":"a14aa233-3ac1-4218-8d85-b168a6c1b6df","name":"l2conn-89a4","project_id":"88104fcc62a640bfa0a0bf687607621c","remote_infos":[{"segmentation_id":9732,"tunnel_ip":"192.168.0.76","tunnel_port":4789,"tunnel_type":"vxlan"}],"status":"disconnect","updated_at":"2025-08-22T02:53:18Z","virsubnet_id":"be272d7a-5111-451a-af8b-09b673b1a7e9","vpc_id":"a36e12f4-b490-4b85-bf41-dc61f8f4f4d7"}],"page_info":{"current_count":2,"previous_marker":"9cb4f6bd-89a0-4633-b53e-c333b8c9277f"},"request_id":"d3301f85b4951cce72aa30e6deae7022"}},"schema":{"$ref":"#/definitions/ListConnectionsResponseBody"}}},"summary":"查询二层连接列表","tags":["二层连接"],"x-api-type":"open-api","x-apiexplorer-hide":"false","x-first-open-time":"","x-hybridcloud":"false","x-is-registered":"Y","x-name":"listConnectionsAllInstances","x-open-region-cloud":"hws,hws_hk,hws_test,hws_eu,dt,dt_test","x-order":5,"x-publishpath":"","x-request-examples-url-1":"GET https://{{endpoint}}/v3/060576782980d5762f9ec014dd2f1148/l2cg/connections","x-scope":"Commercial","x-source":"SelfDeveloped","x-support-sdk":"Y"}}},"product_short":"ESW","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询二层连接列表","tags":"二层连接","uri":null,"version":"2.0"}