APIs

Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

En esta página, se describen los comandos individuales que se pueden usar con los niveles de servicio de red. Para obtener información contextual con instrucciones sobre cómo usar estos comandos, consulta la sección de uso de los niveles de servicio de red.

Las API de los niveles de servicio de red y los comandos de gcloud forman parte de Compute Engine.

Referencia de SDK de gcloud

En esta sección, se cubren los comandos de la CLI de SDK de gcloud.

Direcciones

Consulta el comando crear de gcloud alpha addresses.

Reglas de reenvío

Consulta los comandos crear y actualizar de gcloud alpha forwarding-rules.

Instancias

Consulta el comando crear de gcloud alpha instances.

Plantillas de instancias

Consulta el comando crear de gcloud alpha instance-templates.

Referencia de la API

En esta sección, se cubren los comandos para la API RESTful.

Direcciones INSERT

Petición HTTP

POST https://www.googleapis.com/compute/alpha/projects/[PROJECT_ID]/regions/[REGION]/addresses

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta
project cadena ID del proyecto para esta petición.
region cadena Nombre de la región que concede permiso a esta petición.

Cuerpo de la petición

Proporciona el siguiente recurso de dirección en el cuerpo de la petición.

Atributo Tipo Valor predeterminado Descripción
name cadena Es el nombre del recurso proporcionado por el cliente cuando se crea el recurso. El nombre debe tener entre 1 y 63 caracteres, y cumplir con el RFC1035. En concreto, el nombre debe tener entre 1 y 63 caracteres de largo y debe coincidir con la expresión regular [a-z]([-a-z0-9]*[a-z0-9]). Esto significa que el primer carácter debe ser una letra minúscula y, con la excepción del último carácter que no puede ser un guion, todos los otros caracteres pueden ser un guion, una letra minúscula o un dígito.
address cadena Es la dirección IP externa estática representada por este recurso.
description cadena Es una descripción textual opcional del recurso. La proporciona el cliente cuando se crea el recurso.
networkTier cadena PREMIUM Esto significa el nivel de red que se usa para configurar esta dirección y solo puede adoptar los siguientes valores:
PREMIUM,
STANDARD.

Si no se especifica este campo, se supone que es PREMIUM.

Ejemplo

Petición:
POST https://www.googleapis.com/compute/alpha/projects/[PROJECT_ID]/regions/us-central1/addresses
{
"name": "standard-ip",
"description": "VIP for Network LB",
"networkTier": "STANDARD",
"address": "1.240.100.100"
}

ForwardingRules INSERT

Para configurar una red estándar para el balanceador de carga de red, se debe configurar un ForwardingRule regional que apunte al objetivo. La regla de reenvío regional se configurará con el valor de networkTier STANDARD.

Petición HTTP

POST https://www.googleapis.com/compute/alpha/projects/[PROJECT_ID]/regions/[REGION]/forwardingRules

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta
project cadena ID del proyecto para esta petición.
region cadena Nombre de la región que concede permiso a esta petición.

Cuerpo de la petición

Proporcione el siguiente recurso ForwardingRule en el cuerpo de la petición.

Recurso ForwardingRule

Atributo Tipo Valor predeterminado Descripción
name cadena Es el nombre del recurso proporcionado por el cliente cuando se crea el recurso. El nombre debe tener entre 1 y 63 caracteres, y cumplir con el RFC1035. En concreto, el nombre debe tener entre 1 y 63 caracteres de largo y debe coincidir con la expresión regular [a-z]([-a-z0-9]*[a-z0-9]). Esto significa que el primer carácter debe ser una letra minúscula y, con la excepción del último carácter que no puede ser un guion, todos los otros caracteres pueden ser un guion, una letra minúscula o un dígito.
description cadena Es una descripción textual opcional del recurso. La proporciona el cliente cuando se crea el recurso.
networkTier cadena "PREMIUM" Esto significa el nivel de red que se utiliza para configurar este balanceador de carga y solo puede adoptar los siguientes valores:
PREMIUM,
STANDARD.

Para el recurso ForwardingRule regional, los valores válidos son PREMIUM y STANDARD.

[Nota: Para GlobalForwardingRule, el valor válido es PREMIUM].

Si no se especifica este campo, se supone que es PREMIUM. Si se especifica el recurso IPAddress, este valor debe ser igual al del networkTier de la dirección.
loadBalancingScheme cadena "EXTERNAL" Esto indica el uso que se le dará a ForwardingRule y solo puede adoptar los siguientes valores:
"INTERNAL",
"EXTERNAL".
El valor "INTERNAL" significa que se usará para balanceo de carga interno de la red. El valor "EXTERNAL" significa que se usará para HTTP o HTTPS para balanceo de carga externo.

Solo se permite el valor EXTERNAL con STANDARD.
region cadena [Solo admite valores de salida] URL de la región donde reside la regla de reenvío regional. No se puede aplicar este campo a las reglas de reenvío globales.
IPAddress cadena Valor de la dirección IP reservada por la cual esta regla de reenvío realiza el envío. Para las reglas de reenvío global, la dirección debe ser una IP global. En cambio, para las reglas de reenvío regionales, la dirección debe residir en la misma región que la regla de reenvío. Si se deja vacío (valor predeterminado), se asignará una IP efímera del mismo permiso (global o regional).

Si el recurso networkTier elegido es STANDARD, esta dirección IP debe pertenecer a un recurso Address regional.

Si el recurso networkTier elegido es PREMIUM, esta dirección IP debe pertenecer a un recurso Address regional o global.
IPProtocol cadena "TCP" Es el protocolo de IP al que se aplica esta regla.

portRange cadena Aplicable solo cuando el IPProtocol es TCP, UDP o SCTP. Solo se reenviarán al destino aquellos paquetes dirigidos a los puertos en el intervalo especificado. Las reglas de reenvío con el mismo par [IPAddress, IPProtocol] no deben tener intervalos de puertos contiguos.
target cadena La URL del recurso de destino que recibirá el tráfico coincidente.

Si el destino es regional, debe residir en la misma región que la regla de reenvío.

Si el recurso networkTier elegido es PREMIUM y esta regla de reenvío es global, entonces este destino debe ser un recurso TargetHttpProxy, TargetHttpsProxy, TargetSslProxy o TargetTcpProxy. El tráfico reenviado debe ser de un tipo apropiado para el objeto de destino. A continuación se muestra un ejemplo del tipo de tráfico que requieren los recursos: TargetHttpProxy requiere tráfico HTTP, TargetHttpsProxy requiere tráfico HTTPS, TargetSslProxy requiere tráfico SSL, TargetTcpProxy requiere tráfico TCP.


Si el recurso networkTier elegido es STANDARD, se puede configurar una regla de reenvío regional con un recurso TargetHttpProxy o TargetHttpsProxy global para el balanceo de carga HTTP o HTTPS. Del mismo modo, se puede configurar con un recurso TargetSslProxy o TargetTcpProxy global para el balanceo de carga SSL o TCP. En este caso, los grupos de instancias vinculados al proxy global deberían estar en la misma región que la regla de reenvío regional.

backendService cadena Es una URL de un recurso BackendService que recibe el tráfico coincidente.
subnetwork cadena Es la subred a la que se aplica esta regla de reenvío.

Si la red configurada para esta regla de reenvío está en modo de subred automática, el recurso subnetwork es opcional. Sin embargo, si la red está en modo de subred personalizado, se debe especificar un valor al recurso subnetwork.
network cadena Es la red a la que se aplica esta regla de reenvío.

Ejemplo

Petición:
POST https://www.googleapis.com/compute/alpha/projects/[PROJECT]/regions/[REGION]/forwardingRules
{
"name": "tcp-standard-fr",
"description": "Standard tier LB for TCP server.",
"IPAddress": "65.55.45.1",
"IPProtocol": "tcp",
"networkTier": "STANDARD",
"target": "https://www.googleapis.com/compute/alpha/projects/[PROJECT]/regions/[REGION]/targetPools/[TARGET_POOL]"
}

ForwardingRules PATCH

El método de parche para una regla de reenvío no permite cambiar el nivel de red. Para cambiar de PREMIUM a STANDARD o viceversa, se puede crear una nueva ForwardingRule y se puede eliminar el anterior.

Instancias INSERT

Petición HTTP

POST https://www.googleapis.com/compute/alpha/projects/[PROJECT]/zones/[ZONE]/instances

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta
project cadena ID del proyecto para esta petición.
zone cadena Zona en la que se crea la instancia

Cuerpo de la petición

Nombre del campo Tipo Descripción
networkInterfaces[].accessConfigs[].networkTier cadena Campo opcional: Esto significa que se usa el nivel de red para configurar este recurso de instancia y solo puede adoptar los siguientes valores:
"PREMIUM",
"STANDARD.

Si se especifica un recurso AccessConfig sin una dirección IP externa válida, se creará una dirección IP efímera con este recurso networkTier.

Si se especifica un recurso AccessConfig con una dirección IP externa válida, debe coincidir con el del recurso networkTier asociado al recurso Address que tiene esa dirección IP.

También puedes crear un recurso InstanceTemplate con el valor de networkTier que quieres que todas las instancias tengan, cuando el recurso InstanceTemplate las cree.

InstanceTemplates INSERT

Petición HTTP

POST https://www.googleapis.com/compute/alpha/projects/[PROJECT]/zones/[ZONE]/instanceTemplates

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta
project cadena ID del proyecto para esta petición.
zone cadena Zona en la que se crea la instancia

Cuerpo de la petición

Nombre del campo Tipo Descripción
properties.networkInterfaces[].accessConfigs[].networkTier cadena Campo opcional: Esto significa que se usa el nivel de red para configurar este recurso de instancia y solo puede adoptar los siguientes valores:
"PREMIUM",
"STANDARD.

Si se especifica un recurso AccessConfig sin una dirección IP externa válida, se creará una dirección IP efímera con este recurso networkTier.

Si se especifica un recurso AccessConfig con una dirección IP externa válida, debe coincidir con el del recurso networkTier asociado al recurso Address que tiene esa dirección IP.