Querying Details About a Direct Connect Location
Function
This API is used to query details about a Direct Connect location.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/dcaas/direct-connect-locations/{direct_connect_location_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 0 Maximum: 36 |
direct_connect_location_id |
Yes |
String |
Specifies the Direct Connect location ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
direct_connect_location |
DirectConnectLocationEntry object |
Specifies the details about the Direct Connect location. |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the ID of the Direct Connect location. Minimum: 0 Maximum: 36 |
name |
String |
Specifies the name of the Direct Connect location. Minimum: 0 Maximum: 64 |
region_id |
String |
Specifies the region that the Direct Connect location belongs to. Minimum: 0 Maximum: 36 |
site_code |
String |
Specifies the site code of the Direct Connect location. Minimum: 0 Maximum: 64 |
address |
AddressBody object |
Provides the address of the Direct Connect location. |
locales |
LocalesBody object |
Specifies the locale. |
provider_list |
Array of ProviderResponseBody objects |
Lists the supported carriers. |
public_border_group |
String |
Specifies the public border group that the Direct Connect location belongs to. Minimum: 0 Maximum: 64 |
latitude |
String |
Specifies the latitude of the Direct Connect location. Minimum: 0 Maximum: 36 |
longitude |
String |
Specifies the longitude of the Direct Connect location. Minimum: 0 Maximum: 36 |
description |
String |
Provides supplementary information about the Direct Connect location. Minimum: 0 Maximum: 255 |
created_time |
String |
Specifies the time when the Direct Connect location was created. |
updated_time |
String |
Specifies the time when the Direct Connect location was updated. |
available_port_speeds |
Array of strings |
Specifies available port types at the Direct Connect location. Minimum: 1 Maximum: 255 Array Length: 0 - 6 |
Parameter |
Type |
Description |
---|---|---|
en_us |
String |
English name. Minimum: 0 Maximum: 255 |
zh_cn |
String |
Chinese name. Minimum: 0 Maximum: 255 |
Parameter |
Type |
Description |
---|---|---|
en_us |
String |
Specifies the region name in English. Minimum: 0 Maximum: 255 |
zh_cn |
String |
Specifies the region name in Chinese. Minimum: 0 Maximum: 255 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the carrier ID. Minimum: 0 Maximum: 36 |
short_name |
String |
Specifies the carrier name abbreviation. Minimum: 0 Maximum: 36 |
type |
String |
Specifies the carrier type. Minimum: 0 Maximum: 36 |
provider_value |
ProviderValueBody object |
Specifies the carrier name. |
description |
String |
Provides supplementary information about the carrier. Minimum: 0 Maximum: 36 |
Example Requests
Querying details about a Direct Connect location
GET https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/direct-connect-locations/00825bc2-59e9-4e00-a7f9-e8164971bd93
Example Responses
Status code: 200
OK
- Direct Connect location details that have been queried
{ "direct_connect_location" : { "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" : "Other" } }, { "id" : "b6fd0ad8-dac4-4e21-a987-bce2f28ee861", "short_name" : "telcom", "type" : "LEVEL_ONE", "provider_value" : { "en_us" : "China Telecom", "zh_cn" : "China Telecom" } }, { "id" : "ea30d085-aa48-49b0-a519-8f3085e8137a", "short_name" : "mobile", "type" : "LEVEL_ONE", "provider_value" : { "en_us" : "China Mobile", "zh_cn" : "China Mobile" } }, { "id" : "a237b909-e60d-4292-8afe-9600ddfef755", "short_name" : "unicom", "type" : "LEVEL_ONE", "provider_value" : { "en_us" : "China Unicom", "zh_cn" : "China Unicom" } } ], "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" }, "request_id" : "81cb340e3c33c47c678c7b06a3502552" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.