Inter DC Gateway¶
List Interdc Gateway¶
List all visible interdc_gateways.
Synchronous / Asynchronous¶
- Synchronous 
Request¶
HTTP Request Method¶
- GET 
HTTP Request Path¶
{endpoint}/v2.0/interdc_gateways
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required | 
|---|---|---|---|---|---|---|
| description | query | string | - | - | Description of the Inter DC Gateway resource | no | 
| id | query | string | - | - | Unique ID of the Inter DC Gateway resource | no | 
| interdc_service_id | query | string | hyph-uuid-or-empty | - | Inter DC Service instantiated by this Gateway | no | 
| name | query | string | - | - | Name of the Inter DC Gateway resource | no | 
| status | query | string | - | - | The VPN Gateway status. | no | 
| tenant_id | query | string | non-hyph-uuid | - | Tenant ID of the owner (UUID) | no | 
Response¶
HTTP Response Code List¶
| Response Code | Description | 
|---|---|
| 200 | OK | 
| 400 | Bad Request | 
| 401 | UnAuthorized | 
| 404 | Not Found | 
| 500 | Internal Server Error | 
HTTP Response Parameters¶
| Parameter | Type | Format | Description | 
|---|---|---|---|
| interdc_gateways | array<object> | datatype_interdc_gateway | - | 
| description | string | - | Description of the Inter DC Gateway resource | 
| id | string | - | Unique ID of the Inter DC Gateway resource | 
| interdc_service_id | string | hyph-uuid-or-empty | Inter DC Service instantiated by this Gateway | 
| name | string | - | Name of the Inter DC Gateway resource | 
| status | string | - | The VPN Gateway status. | 
| tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) | 
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
  "interdc_gateways": [
    {
      "description": "interdc_gateway_inet_test, 10M-BE, member role",
      "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
      "interdc_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "name": "lab3-test-member-user-interdc-gateway",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "description": "",
      "id": "4c842674-60e4-48eb-b5a3-b902f832d0af",
      "interdc_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "name": "N000001996_V15000001",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}
Show Interdc Gateway¶
Show details for interdc_gateway.
Synchronous / Asynchronous¶
- Synchronous 
Request¶
HTTP Request Method¶
- GET 
HTTP Request Path¶
{endpoint}/v2.0/interdc_gateways/{interdc_gateway_id}
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required | 
|---|---|---|---|---|---|---|
| interdc_gateway_id | URI | string | hyph-uuid | - | Unique ID of the Inter DC Gateway resource | yes | 
Response¶
HTTP Response Code List¶
| Response Code | Description | 
|---|---|
| 200 | OK | 
| 400 | Bad Request | 
| 401 | UnAuthorized | 
| 404 | Not Found | 
| 500 | Internal Server Error | 
HTTP Response Parameters¶
| Parameter | Type | Format | Description | 
|---|---|---|---|
| interdc_gateway | object | datatype_interdc_gateway | - | 
| description | string | - | Description of the Inter DC Gateway resource | 
| id | string | - | Unique ID of the Inter DC Gateway resource | 
| interdc_service_id | string | hyph-uuid-or-empty | Inter DC Service instantiated by this Gateway | 
| name | string | - | Name of the Inter DC Gateway resource | 
| status | string | - | The VPN Gateway status. | 
| tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) | 
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
  "interdc_gateway": {
    "description": "interdc_gateway_inet_test, 10M-BE, member role",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "interdc_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "name": "lab3-test-member-user-interdc-gateway",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}