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":{"AvailabilityZones":{"properties":{"primary":{"description":"- 参数解释:ESW实例默认主节点所在的可用区。\n- 约束限制:1-128字符。\n- 取值范围:当前区域可用区id。\n- 默认取值:不涉及。","example":"az1","type":"string"},"standby":{"description":"- 参数解释:ESW实例默认备节点所在的可用区。\n- 约束限制:1-128字符。\n- 取值范围:当前区域可用区id。\n- 默认取值:不涉及。","example":"az2","type":"string"}},"required":["primary","standby"],"type":"object"},"Instance":{"properties":{"availability_zones":{"$ref":"#/definitions/AvailabilityZones","description":"- 参数解释:ESW实例节点所在的可用区。\n- 约束限制:不涉及。\n- 取值范围:当前区域可用区。\n- 默认取值:不涉及。"},"charge_infos":{"$ref":"#/definitions/PostPaidChargeInfos","description":"- 参数解释:计费信息。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。"},"created_at":{"description":"- 参数解释:ESW实例创建时间。\n- 约束限制:UTC时间,格式为yyyy-MM-ddTHH:mm:ss。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","format":"date-time","type":"string"},"description":{"description":"- 参数解释:ESW实例描述信息。\n- 约束限制:\n  - 长度范围为0~255个字符。\n  - 不能包含“<”和“>”。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"},"flavor_ref":{"description":"- 参数解释:ESW实例规格。\n- 约束限制:不涉及。\n- 取值范围:参考flavor list接口响应。\n- 默认取值:不涉及。","example":"l2cg.small.ha","type":"string"},"ha_mode":{"description":"- 参数解释:ESW实例的高可用模式。\n- 约束限制:当前只支持设置ha。\n- 取值范围:ha。\n- 默认取值:不涉及。","example":"ha","type":"string"},"id":{"description":"- 参数解释:ESW实例的唯一标识。\n- 约束限制:带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"},"name":{"description":"- 参数解释:ESW实例名称。\n- 约束限制:\n  - 长度范围为1~64个字符。\n  - 名称由中文、英文字母、数字、下划线(_)、中划线(-)、点(.)组成。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","example":"1234","type":"string"},"project_id":{"description":"- 参数解释:ESW实例所属项目ID。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"},"region":{"description":"- 参数解释:ESW实例所属region的ID。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"},"status":{"description":"- 参数解释:ESW实例的状态。\n- 约束限制:不涉及。\n- 取值范围:\n  - active:运行中\n  - failed:创建失败\n  - abnormal:异常\n  - build:创建中\n  - frozen:已冻结\n- 默认取值:不涉及。","type":"string"},"tunnel_info":{"$ref":"#/definitions/TunnelInfoResult","description":"- 参数解释:本端隧道信息。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。"},"updated_at":{"description":"- 参数解释:ESW实例更新时间。\n- 约束限制:UTC时间,格式为yyyy-MM-ddTHH:mm:ss。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","format":"date-time","type":"string"}},"required":["availability_zones","charge_infos","created_at","description","flavor_ref","ha_mode","id","name","project_id","region","status","tunnel_info","updated_at"],"type":"object"},"ListInstancesResponseBody":{"properties":{"instances":{"description":"- 参数解释:查询实例列表响应体。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","items":{"$ref":"#/definitions/Instance"},"type":"array"},"page_info":{"$ref":"#/definitions/PageInfo","description":"- 参数解释:分页信息。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。"},"request_id":{"description":"- 参数解释:请求的唯一标识。\n- 约束限制:UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"}},"required":["instances","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"},"PostPaidChargeInfos":{"description":"支付信息","properties":{"charge_mode":{"description":"- 参数解释:付费方式(后付费,即按需付费)。\n- 约束限制:不涉及。\n- 取值范围:postPaid,后付费,即按需付费。\n- 默认取值:不涉及。","type":"string"}},"required":["charge_mode"],"type":"object"},"TunnelInfoResult":{"properties":{"tunnel_ip":{"description":"- 参数解释:ESW实例的本端隧道IP。\n- 约束限制:不能与已存在的子网IP冲突。\n- 取值范围:标准的IPv4格式,例:192.168.1.1。\n- 默认取值:不涉及。","type":"string"},"tunnel_port":{"description":"- 参数解释:ESW实例的隧道端口。\n- 约束限制:不涉及。\n- 取值范围:4789。\n- 默认取值:不涉及。","format":"int32","type":"integer"},"tunnel_type":{"description":"- 参数解释:ESW实例的隧道协议类型。\n- 约束限制:不涉及。\n- 取值范围:vxlan。\n- 默认取值:不涉及。","type":"string"},"virsubnet_id":{"description":"- 参数解释:ESW所在隧道子网ID。\n- 约束限制:\n  - 需要使用本租户下可操作的子网资源的ID;此值即为子网详情中的“网络ID”参数值。\n  - 带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"},"vpc_id":{"description":"- 参数解释:ESW所在VPC资源ID。\n- 约束限制:\n  - 需要使用本租户下可操作的VPC资源的ID。\n  - 带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","type":"string"}},"required":["tunnel_ip","tunnel_port","tunnel_type","virsubnet_id","vpc_id"],"type":"object"}},"description":null,"group_id":"85bc4f8eac384af6b052b0374dba3eac","host":"esw.cn-north-4.myhuaweicloud.com","id":"22a41c88de1546f6ab84fa0a52c4b419","info_version":"v1","method":"get","name":"ListInstances","parameters":{},"paths":{"/v3/{project_id}/l2cg/instances":{"get":{"description":"当您的ESW实例创建成功后,您可以通过调用此接口查询所有ESW实例的详细信息。","operationId":"ListInstances","parameters":[{"description":"- 参数解释:ESW实例所属项目ID。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"path","name":"project_id","required":true,"type":"string","x-order":1},{"description":"- 参数解释:ESW资源ID。ESW创建成功后,会生成一个ESW ID,是ESW对应的唯一标识。\n- 约束限制:带“-”的UUID格式。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"id","required":false,"type":"string"},{"description":"- 参数解释:ESW实例的名称。\n- 约束限制:\n  - 长度范围为1~64个字符。\n  - 名称由中文、英文字母、数字、下划线(_)、中划线(-)、点(.)组成。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"name","required":false,"type":"string"},{"description":"- 参数解释:ESW实例所属项目ID。\n- 约束限制:不涉及。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"project_id","required":false,"type":"string"},{"description":"- 参数解释:ESW的描述信息。\n- 约束限制:\n  - 长度范围为0~255个字符。\n  - 不能包含“<”和“>”。\n- 取值范围:不涉及。\n- 默认取值:不涉及。","in":"query","name":"description","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":{"instances":[{"availability_zones":{"primary":"cn-southwest-242a","standby":"cn-southwest-242a"},"charge_infos":{"charge_mode":"postPaid"},"created_at":"2025-05-27T09:12:50Z","flavor_ref":"l2cg.small.ha","ha_mode":"ha","id":"a14aa233-3ac1-4218-8d85-b168a6c1b6df","name":"esw-offline-inter","project_id":"88104fcc62a640bfa0a0bf687607621c","region":"cn-southwest-242","status":"active","tunnel_info":{"tunnel_ip":"192.168.4.202","tunnel_port":4789,"tunnel_type":"vxlan","virsubnet_id":"fb9dee2e-88eb-4fa8-b698-e089d29a56ee","vpc_id":"a36e12f4-b490-4b85-bf41-dc61f8f4f4d7"},"updated_at":"2025-07-26T04:57:15Z"},{"availability_zones":{"primary":"cn-southwest-242a","standby":"cn-southwest-242a"},"charge_infos":{"charge_mode":"postPaid"},"created_at":"2025-05-20T07:51:52Z","flavor_ref":"l2cg.small.ha","ha_mode":"ha","id":"16b2eea7-5935-445d-8410-083b7064b939","name":"esw-online-update","project_id":"88104fcc62a640bfa0a0bf687607621c","region":"cn-southwest-242","status":"active","tunnel_info":{"tunnel_ip":"192.168.0.76","tunnel_port":4789,"tunnel_type":"vxlan","virsubnet_id":"71f74174-c3fb-4929-9207-a4256b19e280","vpc_id":"41829b5e-66c0-4928-a3d4-f4570ce81d8f"},"updated_at":"2025-07-28T08:29:14Z"}],"page_info":{"current_count":2,"previous_marker":"a14aa233-3ac1-4218-8d85-b168a6c1b6df"},"request_id":"ca8bd3285faf5a0e600cc9e66032b4b9"}},"schema":{"$ref":"#/definitions/ListInstancesResponseBody"}}},"summary":"查询ESW实例列表","tags":["企业交换机"],"x-api-type":"open-api","x-apiexplorer-hide":"false","x-first-open-time":"","x-hybridcloud":"false","x-is-registered":"Y","x-name":"listInstances","x-open-region-cloud":"hws,hws_hk,hws_test,hws_eu,dt,dt_test","x-order":3,"x-publishpath":"","x-request-examples-url-1":"GET https://{endpoint}/v3/88104fcc62a640bfa0a0bf687607621c/l2cg/instances","x-scope":"Commercial","x-source":"SelfDeveloped","x-support-sdk":"Y"}}},"product_short":"ESW","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询ESW实例列表","tags":"企业交换机","uri":null,"version":"2.0"}