huawei-cloud-api-definitions-DC 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":{"parameters":{"AuthToken":{"description":"用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"schema":{"maxLength":10240,"minLength":0,"type":"string"}},"ExtFields":{"description":"show response ext-fields","in":"query","name":"ext_fields","schema":{"items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"}},"Fields":{"description":"显示字段列表","in":"query","name":"fields","required":false,"schema":{"items":{"maxLength":100,"minLength":0,"type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"Limit":{"description":"每页返回的个数。\n取值范围:1~2000。","example":10,"in":"query","name":"limit","schema":{"default":2000,"format":"int32","maximum":2000,"minimum":1,"type":"integer"}},"Marker":{"description":"上一页最后一条资源记录的ID,为空时为查询第一页。\n使用说明:必须与limit一起使用。","example":"7f7f738f-453c-40b1-be26-28e7b9e390c1","in":"query","name":"marker","schema":{"maxLength":36,"minLength":0,"type":"string"}},"Offset":{"description":"分页偏移量","in":"query","name":"offset","required":false,"schema":{"example":10,"format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"PageReverse":{"description":"分页参数","in":"query","name":"page_reverse","required":false,"schema":{"type":"boolean"}},"ProjectId":{"description":"租户项目ID","in":"path","name":"project_id","required":true,"schema":{"maxLength":36,"minLength":0,"pattern":"[a-fA-F0-9]{32}","type":"string"}},"QueryById":{"description":"根据资源ID过滤实例","explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"style":"form"},"QueryByName":{"description":"根据名字过滤查询,可查询多个名字。","example":["resourceA"],"explode":false,"in":"query","name":"name","schema":{"items":{"maxLength":64,"minLength":1,"pattern":"^[\\u4e00-\\u9fa50-9a-zA-Z_.\\-]+$","type":"string"},"maxItems":5,"minItems":1,"type":"array"},"style":"form"},"QueryByState":{"description":"根椐资源状态过滤实例","explode":true,"in":"query","name":"status","schema":{"items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"style":"form"},"SortDir":{"description":"返回结果按照升序(asc)或降序(desc)排列,默认为asc","in":"query","name":"sort_dir","required":false,"schema":{"items":{"enum":["asc","desc"],"type":"string"},"type":"array"}},"SortKey":{"description":"排序字段。","example":["id"],"in":"query","name":"sort_key","required":false,"schema":{"default":"id","maxLength":36,"minLength":0,"type":"string"}}},"schemas":{"ConnectGatewayResponse":{"description":"互联网关的相信信息对象","properties":{"access_site":{"description":"网关站点值","type":"string"},"address_family":{"description":"地址族信息\n- ipv4: 仅支持ipv4模式\n- dual: 支持ipv4 和 ipv6 模式","enum":["ipv4","dual"],"type":"string"},"bgp_asn":{"description":"BGP类型AS号","format":"int64","type":"integer"},"created_time":{"description":"创建时间","format":"date-time","type":"string"},"current_geip_count":{"description":"当前绑定的global eip数量","type":"integer"},"description":{"description":"描述信息","type":"string"},"gateway_site":{"description":"网关位置","type":"string"},"gcb_id":{"description":"带宽包id","type":"string"},"id":{"description":"唯一ID","type":"string"},"name":{"description":"网关名字","type":"string"},"status":{"description":"网关状态\n- DOWN 未使用或关联设备状态为DOWN\n- ACTIVE 正常\n- ERROR 异常","type":"string"},"tenant_id":{"description":"租户项目ID","type":"string"},"updated_time":{"description":"更新时间","format":"date-time","type":"string"}},"type":"object"},"ListConnectGatewayResponseBody":{"properties":{"connect_gateways":{"items":{"$ref":"#/components/schemas/ConnectGatewayResponse"},"type":"array"},"page_info":{"$ref":"#/components/schemas/PageInfo"},"request_id":{"description":"请求ID","type":"string"},"total_count":{"description":"总记录数。","example":10,"format":"int32","type":"integer"}},"type":"object"},"PageInfo":{"description":"分页查询页的信息","properties":{"current_count":{"description":"当前列表中资源数量","format":"int32","maximum":2000,"minimum":0,"type":"integer"},"next_marker":{"description":"下一页的marker,值为资源的uuid,为空时表示最后一页","maxLength":36,"minLength":0,"type":"string"},"previous_marker":{"description":"上一页的marker,值为资源的uuid","maxLength":36,"minLength":0,"type":"string"}},"required":["current_count","previous_marker"],"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"06bf85ad252047f6bd3ba876c6c55ed5","info_version":"v3","method":"get","name":"ListConnectGateways","parameters":null,"paths":{"/v3/{project_id}/dcaas/connect-gateways":{"get":{"description":"查询互联网关列表信息","operationId":"ListConnectGateways","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Marker"},{"$ref":"#/components/parameters/PageReverse"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Fields"},{"$ref":"#/components/parameters/ExtFields"},{"$ref":"#/components/parameters/SortKey"},{"$ref":"#/components/parameters/SortDir"},{"$ref":"#/components/parameters/QueryById"},{"$ref":"#/components/parameters/QueryByName"},{"$ref":"#/components/parameters/QueryByState"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectGatewayResponseBody"}}},"description":"OK","x-response-examples-1":{"application/json":{"connect_gateways":[{"access_site":null,"address_family":"dual","bgp_asn":139144,"created_time":"2024-12-12T06:12:15Z","current_geip_count":0,"description":"","gateway_site":null,"gcb_id":null,"id":"934aa302-5f1a-44c8-855b-20f715e2dbf3","name":"cgw-test","status":"DOWN","tenant_id":"b197c48159d44a66b32c538c3f8da89a","updated_time":null}],"page_info":{"current_count":1,"previous_marker":"0ffe48a8-053a-483d-aa04-70f675eda4e6"},"request_id":"620dd1f696304f95a5d4fa4b9a21505e","total_count":1}},"x-response-examples-description-1":"互联网关列表查询结果"}},"summary":"查询互联网关列表信息","tags":["ConnectGateway"],"x-apiexplorer-hide":false,"x-is-registered":"Y","x-request-examples-description-1":"查询互联网关列表信息","x-request-examples-url-1":"GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways","x-support-sdk":"Y"}}},"product_short":"DC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询互联网关列表信息","tags":"互联网关","uri":null,"version":"3.0.1"}