GCP Gateway

This page describes operations you can perform on gcp_gateways. List, and get details for.

List Gcp Gateway

List all visible gcp_gateways.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/gcp_gateways

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Description of the GCP Gateway resource no
gcp_service_id query string hyph-uuid-or-empty - GCP Service instantiated by this Gateway no
id query string - - Unique ID of the GCP Gateway resource no
name query string - - Name of the GCP Gateway resource no
qos_option_id query string hyph-uuid-or-empty - Quality of Service options selected for this Gateway no
status query string - - The GCP 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
gcp_gateways array<object> GCP Gateway -
description string - Description of the GCP Gateway resource
gcp_service_id string hyph-uuid-or-empty GCP Service instantiated by this Gateway
id string - Unique ID of the GCP Gateway resource
name string - Name of the GCP Gateway resource
qos_option_id string hyph-uuid-or-empty Quality of Service options selected for this Gateway
status string - The GCP 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

{
  "gcp_gateways": [
    {
      "description": "gcp_gateway_inet_test, 10M-BE, member role",
      "gcp_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
      "name": "test-member-user-gcp-gateway",
      "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "description": "",
      "gcp_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "id": "4c842674-60e4-48eb-b5a3-b902f832d0af",
      "name": "N000001996_V15000001",
      "qos_option_id": "aa776ce4-08a8-4cc1-9a2c-bb95e547916b",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Show Gcp Gateway

Show details for gcp_gateway.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/gcp_gateways/{gcp_gateway_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
gcp_gateway_id URI string hyph-uuid - Unique ID of the GCP 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
gcp_gateway object GCP Gateway -
description string - Description of the GCP Gateway resource
gcp_service_id string hyph-uuid-or-empty GCP Service instantiated by this Gateway
id string - Unique ID of the GCP Gateway resource
name string - Name of the GCP Gateway resource
qos_option_id string hyph-uuid-or-empty Quality of Service options selected for this Gateway
status string - The GCP 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

{
  "gcp_gateway": {
    "description": "gcp_gateway_inet_test, 10M-BE, member role",
    "gcp_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
    "id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
    "name": "test-member-user-gcp-gateway",
    "qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}