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"}},"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"}},"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":{"AddressBody":{"description":"专线接入点的位置信息。","properties":{"en_us":{"description":"英文名称。","example":"china-jiangsu-suzhou-A21","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"},"zh_cn":{"description":"中文信息。","example":"中国江苏苏州AZ1","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"}},"type":"object"},"DirectConnectLocationEntry":{"description":"direct-connect-location专线接入点详情","properties":{"address":{"$ref":"#/components/schemas/AddressBody"},"available_port_speeds":{"description":"接入点内设备可选的端口类型","example":["40GE","10GE"],"items":{"maxLength":255,"minLength":1,"type":"string"},"maxItems":6,"maxLength":36,"minItems":0,"minLength":1,"type":"array"},"created_time":{"description":"创建时间。","format":"date-time","type":"string"},"description":{"description":"描述信息。","example":"direct-connect-location-description","maxLength":255,"minLength":0,"type":"string","x-ifnull":"hide"},"id":{"description":"专线接入站点资源的ID","example":"deddb081-a65b-4d3f-881a-c6a60114e9ad","maxLength":36,"minLength":0,"type":"string"},"latitude":{"description":"地理位置纬度","example":"170.1","maxLength":36,"minLength":0,"type":"string","x-ifnull":"hide"},"locales":{"$ref":"#/components/schemas/LocalesBody"},"longitude":{"description":"地理位置经度","example":"100.2","maxLength":36,"minLength":0,"type":"string"},"name":{"description":"专线接入点的名称","example":"cn-north-beijing-langfang","maxLength":64,"minLength":0,"type":"string","x-ifnull":"hide"},"provider_list":{"$ref":"#/components/schemas/ProviderListBody"},"public_border_group":{"description":"专线接入点所属public_border_group","example":"center","maxLength":64,"minLength":0,"type":"string"},"region_id":{"description":"Location所属Region","example":"d8215fcf-becf-edf7-8649-260ed504b226","maxLength":36,"minLength":0,"type":"string"},"site_code":{"description":"专线接入点对应的站点编码","example":"area-subArea-city","maxLength":64,"minLength":0,"type":"string","x-ifnull":"hide"},"updated_time":{"description":"更新时间。","format":"date-time","type":"string"}}},"ListDirectConnectLocationsResponseBody":{"description":"查询direct-connect-location列表的返回体","properties":{"direct_connect_locations":{"description":"专线接入点列表","items":{"$ref":"#/components/schemas/DirectConnectLocationEntry"},"maxItems":2000,"minItems":0,"type":"array"},"page_info":{"$ref":"#/components/schemas/PageInfo"},"request_id":{"description":"请求ID。","example":"4ad3ef5a-5598-49ba-ab91-7c488cfe5723","maxLength":36,"minLength":0,"type":"string"}},"type":"object"},"LocalesBody":{"description":"Locale地址描述信息。","properties":{"en_us":{"description":"区域英文名称。","example":"hangzhou-Odin","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"},"zh_cn":{"description":"区域中文名称。","example":"杭州奥丁","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string","x-open-region-cloud":"hws,hws_hk,hws_eu,hcs,fcs,hcs_sm,hcso_g42,hcso_g42_b,mix,cmcc,ctc,hws_ocb,hk_sbc,hk_tm,hk_g42,hk_vdf"}},"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"},"ProviderListBody":{"description":"可支持的运营商列表。","items":{"$ref":"#/components/schemas/ProviderResponseBody"},"maxItems":100,"minItems":1,"type":"array"},"ProviderResponseBody":{"description":"运营商的返回体。","properties":{"description":{"description":"运营商说明","example":"中国移动","maxLength":36,"minLength":0,"pattern":"^[\\u4e00-\\u9fa50-9a-zA-Z_.\\-]+$","type":"string"},"id":{"description":"运营商id","example":"cef6293371db41929ffd7459d5fd6e01","maxLength":36,"minLength":0,"pattern":"[a-zA-Z0-9_-]{32}","type":"string"},"provider_value":{"$ref":"#/components/schemas/ProviderValueBody"},"short_name":{"description":"运营商简写","example":"cmcc","maxLength":36,"minLength":0,"pattern":"^[\\u4e00-\\u9fa50-9a-zA-Z_.\\-]+$","type":"string"},"type":{"description":"运营商类型","example":"LEVEL_ONE","maxLength":36,"minLength":0,"pattern":"[LEVEL_ONE | LEVEL_TWO]","type":"string"}},"type":"object"},"ProviderValueBody":{"description":"运营商名称","properties":{"en_us":{"description":"英文名称。","example":"hangzhou-Odin","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"},"zh_cn":{"description":"中文信息。","example":"杭州奥丁","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"}},"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"b926045bffc542ebb12d333f50126599","info_version":"v3","method":"get","name":"ListDirectConnectLocations","parameters":null,"paths":{"/v3/{project_id}/dcaas/direct-connect-locations":{"get":{"description":"查询本区域下所有专线的接入点的信息,分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效","operationId":"ListDirectConnectLocations","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Marker"},{"$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/ListDirectConnectLocationsResponseBody"}}},"description":"OK","x-response-examples-1":{"application/json":{"direct_connect_locations":[{"address":{"en_us":"Beijing4","zh_cn":"北京4"},"available_port_speeds":["100G","1G","10G","40G"],"city":"Beijing","created_time":"2023-11-23T01:24:52.000Z","description":"test","id":"00825bc2-59e9-4e00-a7f9-e8164971bd93","latitude":"26.6476","locales":{"en_us":"Beijing-4","zh_cn":"北京-4"},"location_type":"pop","longitude":"106.6302","name":"Beijing4","provider_list":[{"id":"773dd278-1cae-4a8c-ad53-f2d8e8a9b9f9","provider_value":{"en_us":"Other","zh_cn":"其他"},"short_name":"others","type":"LEVEL_TWO"},{"id":"b6fd0ad8-dac4-4e21-a987-bce2f28ee861","provider_value":{"en_us":"China Telecom","zh_cn":"中国电信"},"short_name":"telcom","type":"LEVEL_ONE"},{"id":"ea30d085-aa48-49b0-a519-8f3085e8137a","provider_value":{"en_us":"China Mobile","zh_cn":"中国移动"},"short_name":"mobile","type":"LEVEL_ONE"},{"id":"a237b909-e60d-4292-8afe-9600ddfef755","provider_value":{"en_us":"China Unicom","zh_cn":"中国联通"},"short_name":"unicom","type":"LEVEL_ONE"}],"public_border_group":null,"region_id":"cn-southwest-242","site_code":"cn-north-beijing4","support_region_type":"None","updated_time":"2024-08-24T01:26:18.911Z"}],"page_info":{"current_count":1,"previous_marker":"00825bc2-59e9-4e00-a7f9-e8164971bd93"},"request_id":"cb4aaa7fe6b5d4d769e84935aed477a2"}},"x-response-examples-description-1":"专线位置查询列表结果"}},"summary":"查询专线接入点位置列表","tags":["DirectConnectLocation"],"x-huawei-security":{"enableEProject":true,"epsAction":"list","pdpKey":"dcaas:DirectConnectLocation:list"},"x-is-registered":"Y","x-request-examples-description-1":"查询专线接入点位置列表","x-request-examples-url-1":"GET https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/direct-connect-locations","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"}