查询专线接入点位置列表
功能介绍
查询本区域下所有专线的接入点的信息,分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/dcaas/direct-connect-locations
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID 最小长度:0 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~2000。 最小值:1 最大值:2000 缺省值:2000 |
marker |
否 |
String |
上一页最后一条资源记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 |
sort_key |
否 |
String |
排序字段。 缺省值:id 最小长度:0 最大长度:36 |
sort_dir |
否 |
Array of strings |
返回结果按照升序(asc)或降序(desc)排列,默认为asc |
id |
否 |
Array of strings |
根据资源ID过滤实例 数组长度:1 - 5 |
name |
否 |
Array of strings |
根据名字过滤查询,可查询多个名字。 数组长度:1 - 5 |
status |
否 |
Array of strings |
根椐资源状态过滤实例 数组长度:1 - 5 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
direct_connect_locations |
Array of DirectConnectLocationEntry objects |
专线接入点列表 数组长度:0 - 2000 |
page_info |
PageInfo object |
分页查询页的信息 |
request_id |
String |
请求ID。 最小长度:0 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
专线接入站点资源的ID 最小长度:0 最大长度:36 |
name |
String |
专线接入点的名称 最小长度:0 最大长度:64 |
region_id |
String |
Location所属Region 最小长度:0 最大长度:36 |
site_code |
String |
专线接入点对应的站点编码 最小长度:0 最大长度:64 |
address |
AddressBody object |
专线接入点的位置信息。 |
locales |
LocalesBody object |
Locale地址描述信息。 |
provider_list |
Array of ProviderResponseBody objects |
可支持的运营商列表。 |
public_border_group |
String |
专线接入点所属public_border_group 最小长度:0 最大长度:64 |
latitude |
String |
地理位置纬度 最小长度:0 最大长度:36 |
longitude |
String |
地理位置经度 最小长度:0 最大长度:36 |
description |
String |
描述信息。 最小长度:0 最大长度:255 |
created_time |
String |
创建时间。 |
updated_time |
String |
更新时间。 |
available_port_speeds |
Array of strings |
接入点内设备可选的端口类型 最小长度:1 最大长度:255 数组长度:0 - 6 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
运营商id 最小长度:0 最大长度:36 |
short_name |
String |
运营商简写 最小长度:0 最大长度:36 |
type |
String |
运营商类型 最小长度:0 最大长度:36 |
provider_value |
ProviderValueBody object |
运营商名称 |
description |
String |
运营商说明 最小长度:0 最大长度:36 |
请求示例
查询专线接入点位置列表
GET https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/direct-connect-locations
响应示例
状态码: 200
OK
- 专线位置查询列表结果
{ "request_id" : "cb4aaa7fe6b5d4d769e84935aed477a2", "direct_connect_locations" : [ { "name" : "Beijing4", "id" : "00825bc2-59e9-4e00-a7f9-e8164971bd93", "region_id" : "xxxxxx", "site_code" : "xxxxxx", "address" : { "en_us" : "xxx", "zh_cn" : "xxx" }, "public_border_group" : null, "locales" : { "en_us" : "xxx", "zh_cn" : "xxx" }, "provider_list" : [ { "id" : "773dd278-1cae-4a8c-ad53-f2d8e8a9b9f9", "short_name" : "others", "type" : "LEVEL_TWO", "provider_value" : { "en_us" : "Other", "zh_cn" : "其他" } }, { "id" : "b6fd0ad8-dac4-4e21-a987-bce2f28ee861", "short_name" : "telcom", "type" : "LEVEL_ONE", "provider_value" : { "en_us" : "China Telecom", "zh_cn" : "中国电信" } }, { "id" : "ea30d085-aa48-49b0-a519-8f3085e8137a", "short_name" : "mobile", "type" : "LEVEL_ONE", "provider_value" : { "en_us" : "China Mobile", "zh_cn" : "中国移动" } }, { "id" : "a237b909-e60d-4292-8afe-9600ddfef755", "short_name" : "unicom", "type" : "LEVEL_ONE", "provider_value" : { "en_us" : "China Unicom", "zh_cn" : "中国联通" } } ], "latitude" : "26.6476", "longitude" : "106.6302", "description" : "test", "created_time" : "2023-11-23T01:24:52.000Z", "updated_time" : "2024-08-24T01:26:18.911Z", "available_port_speeds" : [ "100G", "1G", "10G", "40G" ], "location_type" : "pop", "city" : "Beijing", "support_region_type" : "None" } ], "page_info" : { "previous_marker" : "00825bc2-59e9-4e00-a7f9-e8164971bd93", "current_count" : 1 } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。