Querying Details About a Global DC Gateway
Function
This API is used to query details about a global DC gateway.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 0 Maximum: 36 |
global_dc_gateway_id |
Yes |
String |
Specifies the global DC gateway ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of records returned on each page. Value range: 1 to 2000 Minimum: 1 Maximum: 2000 Default: 2000 |
fields |
No |
Array of strings |
Specifies the list of fields to be displayed. Array Length: 1 - 5 |
ext_fields |
No |
Array of strings |
show response ext-fields Array Length: 0 - 5 |
enterprise_project_id |
No |
Array of strings |
Specifies the enterprise project ID for querying instances. Array Length: 1 - 10 |
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 |
---|---|---|
global_dc_gateway |
GlobalDcGatewayEntry object |
Specifies the global DC gateway. |
request_id |
String |
Specifies the request ID. Minimum: 0 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the global DC gateway ID. Minimum: 0 Maximum: 36 |
tenant_id |
String |
Specifies the project ID. Minimum: 0 Maximum: 255 |
name |
String |
Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 128 |
reason |
String |
Specifies the cause of the failure to create the global DC gateway. Minimum: 0 Maximum: 255 |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the global DC gateway belongs to. Minimum: 0 Maximum: 36 |
global_center_network_id |
String |
Specifies the ID of the central network that the global DC gateway is added to. Minimum: 0 Maximum: 36 |
bgp_asn |
Long |
Specifies the BGP ASN of the global DC gateway. Minimum: 0 Maximum: 65535 |
region_id |
String |
Specifies the region of the global DC gateway. Minimum: 0 Maximum: 36 |
location_name |
String |
Specifies the location where the underlying device of the global DC gateway is deployed. Minimum: 0 Maximum: 36 |
locales |
LocalesBody object |
Specifies the locale. |
current_peer_link_count |
Integer |
Specifies the number of peer links allowed on a global DC gateway, indicating the number of enterprise routers that the global DC gateway can be attached to. |
available_peer_link_count |
Integer |
Specifies the number of peer links that can be created for a global DC gateway. |
admin_state_up |
Boolean |
Specifies the administrative status of the global DC gateway.
|
status |
String |
Specifies the status of the global DC gateway.- DOWN: The global DC gateway is faulty.- PENDING_UPDATE: The global DC gateway is being updated.- ACTIVE: The global DC gateway is available.- ERROR: An error occurred. |
created_time |
String |
Specifies the time when the global DC gateway was created. |
updated_time |
String |
Specifies the time when the global DC gateway was updated. |
address_family |
String |
Specifies the IP address family of the global DC gateway.
|
Example Requests
Querying details about a global DC gateway
GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5
Example Responses
Status code: 200
OK
-
Global DC gateway details that have been queried
{ "global_dc_gateway" : { "enterprise_project_id" : "0", "name" : "dgw-2c18", "id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5", "tenant_id" : "b197c48159d44a66b32c538c3f8da89a", "description" : "", "tags" : [ ], "status" : "DOWN", "reason" : null, "admin_state_up" : true, "created_time" : "2024-12-12T07:33:19.000Z", "updated_time" : "2024-12-12T07:33:19.000Z", "bgp_asn" : 64512, "global_center_network_id" : null, "current_peer_link_count" : 0, "available_peer_link_count" : 3, "location_name" : null, "locales" : null, "region_id" : null, "address_family" : "ipv4" } }
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.