Empezar a usar Cloud Endpoints para Kubernetes con ESP

OpenAPI   |  gRPC

En este tutorial se muestra cómo configurar y desplegar una API de ejemplo y el Extensible Service Proxy (ESP) en un clúster de Kubernetes que no está en Google Cloud. Si quieres usar Google Kubernetes Engine (GKE), consulta el artículo Empezar a usar Endpoints en GKE.

La API REST del código de ejemplo se describe mediante la especificación de OpenAPI. En el tutorial también se explica cómo crear una clave de API para enviar solicitudes a la API.

En el tutorial se usan imágenes de contenedor precompiladas del código de ejemplo y del ESP, que se almacenan en Artifact Registry. Si no conoces los contenedores, consulta la siguiente información:

• Desplegar una aplicación web en contenedores.
• Imágenes de contenedor de Kubernetes.

Para obtener una descripción general de Cloud Endpoints, consulta Acerca de Endpoints y Arquitectura de Endpoints.

Descargar el código de ejemplo

También puedes descargar el código de muestra. En este tutorial, desplegarás una imagen de contenedor prediseñada, por lo que no tendrás que crear un contenedor a partir del código de ejemplo. Sin embargo, puede que quieras descargar el código de muestra, que se proporciona en varios idiomas para ayudarte a entender cómo funciona la API de muestra.

Para descargar el código de muestra, sigue estos pasos:

Java

Para clonar o descargar la API de ejemplo, sigue estos pasos:

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd java-docs-samples/endpoints/getting-started

Python

Para clonar o descargar la API de ejemplo, sigue estos pasos:

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd python-docs-samples/endpoints/getting-started

Ir

Para clonar o descargar la API de ejemplo, sigue estos pasos:

1. Asegúrate de que la variable de entorno GOPATH esté definida.
2. Clona el repositorio de aplicaciones de muestra en la máquina local:

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. Accede al directorio que contiene el código de muestra:

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

Para clonar o descargar la API de ejemplo, sigue estos pasos:

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd php-docs-samples/endpoints/getting-started

Ruby

Para clonar o descargar la API de ejemplo, sigue estos pasos:

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

Para clonar o descargar la API de ejemplo, sigue estos pasos:

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd nodejs-docs-samples/endpoints/getting-started

Obtener el archivo de configuración de Kubernetes

1. Clona en tu máquina local el repositorio de GitHub que contiene los archivos yaml que se usan en este tutorial:

    git clone https://github.com/googlecloudplatform/endpoints-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Cambia al directorio que contiene los archivos de configuración:

    cd endpoints-samples/kubernetes

Configurar Endpoints

El código de ejemplo incluye el archivo de configuración de OpenAPI, openapi.yaml, que se basa en la especificación de OpenAPI v2.0.

Para configurar Endpoints, haz lo siguiente:

1. En el directorio de código de ejemplo, abre el archivo de configuración openapi.yaml.
   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ten en cuenta lo siguiente:

   • En el ejemplo de configuración se muestran las líneas cercanas al campo host, que debe modificar. Para desplegar el archivo openapi.yaml en Endpoints, se necesita el documento OpenAPI completo.
   • El archivo de ejemplo openapi.yaml contiene una sección para configurar la autenticación que no es necesaria en este tutorial. No es necesario configurar las líneas con YOUR-SERVICE-ACCOUNT-EMAIL y YOUR-CLIENT-ID.
   • OpenAPI es una especificación independiente del lenguaje. El mismo archivo openapi.yaml se encuentra en el ejemplo getting-started de cada repositorio de GitHub de idioma para mayor comodidad.

2. En el campo host, sustituye el texto por el nombre del servicio Endpoints, que debe tener el siguiente formato:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

   Sustituye YOUR_PROJECT_ID por el ID de tu proyecto. Google Cloud Por ejemplo:

   host: "echo-api.endpoints.example-project-12345.cloud.goog"

Ten en cuenta que echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog es el nombre del servicio Endpoints. No es el nombre de dominio completo (FQDN) que usas para enviar solicitudes a la API.

Para obtener información sobre los campos del documento OpenAPI que requiere Endpoints, consulta Configurar Endpoints.

Una vez que hayas completado todos los pasos de configuración que se indican a continuación y puedas enviar solicitudes correctamente a la API de ejemplo mediante una dirección IP, consulta el artículo Configurar DNS para endpoints para obtener información sobre cómo configurar echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog como FQDN.

Desplegar la configuración de Endpoints

Para desplegar la configuración de Endpoints, usa el comando gcloud endpoints services deploy. Este comando usa Gestión de servicios para crear un servicio gestionado.

Para desplegar la configuración de Endpoints, sigue estos pasos:

1. Asegúrate de que estás en el directorio endpoints-samples/k8s.
2. Sube la configuración y crea un servicio gestionado:

   gcloud endpoints services deploy openapi.yaml
   

El comando gcloud llama a la API Service Management para crear un servicio gestionado con el nombre que has especificado en el campo host del archivo openapi.yaml. Gestión de servicios configura el servicio según los ajustes del archivo openapi.yaml. Cuando hagas cambios en openapi.yaml, debes volver a implementar el archivo para actualizar el servicio Endpoints.

Mientras crea y configura el servicio, Gestión de servicios muestra información en la terminal. Puedes ignorar las advertencias sobre las rutas del archivo openapi.yaml que no requieren una clave de API. Cuando termine de configurar el servicio, Service Management mostrará un mensaje con el ID de configuración del servicio y el nombre del servicio, similar al siguiente:

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

En el ejemplo anterior, 2017-02-13r0 es el ID de configuración del servicio y echo-api.endpoints.example-project-12345.cloud.goog es el servicio Endpoints. El ID de configuración del servicio consta de una marca de fecha seguida de un número de revisión. Si vuelves a implementar el archivo openapi.yaml el mismo día, el número de revisión se incrementará en el ID de configuración del servicio. Puedes ver la configuración del servicio Endpoints en la página Endpoints > Services (Servicios) de la consola de Google Cloud .

Si aparece un mensaje de error, consulta Solucionar problemas de despliegue de la configuración de Endpoints.

Comprobando los servicios necesarios

Como mínimo, Endpoints y ESP requieren que los siguientes servicios de Google estén habilitados:

Nombre	Título
servicemanagement.googleapis.com	API Service Management
servicecontrol.googleapis.com	API Service Control

En la mayoría de los casos, el comando gcloud endpoints services deploy habilita estos servicios obligatorios. Sin embargo, el comando gcloud se completa correctamente, pero no habilita los servicios necesarios en las siguientes circunstancias:

• Si has usado una aplicación de terceros, como Terraform, y no incluyes estos servicios.

• Has desplegado la configuración de Endpoints en unGoogle Cloud proyecto en el que estos servicios se han inhabilitado explícitamente.

Usa el siguiente comando para confirmar que los servicios necesarios están habilitados:

gcloud services list

Si no ves los servicios necesarios, habilítalos:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

También debes habilitar el servicio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Para determinar el ENDPOINTS_SERVICE_NAME, puedes hacer lo siguiente:

• Después de desplegar la configuración de Endpoints, ve a la página Endpoints de la consola de Cloud. La lista de posibles ENDPOINTS_SERVICE_NAME se muestra en la columna Nombre del servicio.

• En OpenAPI, ENDPOINTS_SERVICE_NAME es el valor que has especificado en el campo host de tu especificación de OpenAPI. En gRPC, ENDPOINTS_SERVICE_NAME es el valor que has especificado en el campo name de tu configuración de endpoints de gRPC.

Para obtener más información sobre los comandos de gcloud, consulta los servicios de gcloud.

Crear credenciales para tu servicio

Para gestionar tu API, tanto ESP como ESPv2 requieren los servicios de Infraestructura de servicios. Para llamar a estos servicios, ESP y ESPv2 deben usar tokens de acceso. Cuando despliegas ESP o ESPv2 en entornos como GKE, Compute Engine o el entorno flexible de App Engine, ESP y ESPv2 obtienen tokens de acceso por ti a través del servicio de metadatos. Google Cloud Google Cloud

Cuando implementas ESP o ESPv2 en un entorno que no es deGoogle Cloud , como tu ordenador local, un clúster de Kubernetes local u otro proveedor de servicios en la nube, debes proporcionar un archivo JSON de cuenta de servicio que contenga una clave privada. ESP y ESPv2 usan la cuenta de servicio para generar tokens de acceso con los que llamar a los servicios que necesita para gestionar tu API.

Puedes usar la Google Cloud consola o la CLI de Google Cloud para crear la cuenta de servicio y el archivo de clave privada:

Consola

1. En la Google Cloud consola, abre la página Cuentas de servicio .

   Ir a la página Cuentas de servicio

2. Haz clic en Seleccionar un proyecto.
3. Selecciona el proyecto en el que se creó la API y haz clic en Abrir.
4. Haz clic en + Crear cuenta de servicio.
5. En el campo Nombre de cuenta de servicio, introduce el nombre de tu cuenta de servicio.
6. Haz clic en Crear.
7. Haz clic en Continuar.
8. Haz clic en Listo.
9. Haz clic en la dirección de correo de la cuenta de servicio que acabas de crear.
10. Haz clic en Teclas.
11. Haz clic en Añadir clave y, a continuación, en Crear clave.

12. Haz clic en Crear. Se descargará un archivo de clave JSON en tu ordenador.

    Asegúrate de almacenar el archivo de claves de forma segura, ya que se puede usar para autenticarte como tu cuenta de servicio. Puedes mover y cambiar el nombre de este archivo como quieras.

13. Haz clic en Cerrar.

gcloud

1. Introduce lo siguiente para mostrar los IDs de tus Google Cloud proyectos:

   gcloud projects list

2. Sustituye PROJECT_ID en el siguiente comando para definir el proyecto predeterminado como aquel en el que se encuentra tu API:

   gcloud config set project PROJECT_ID

   Importante: Debes crear la cuenta de servicio en el mismo proyecto en el que se encuentra tu API.

3. Asegúrate de que la CLI de Google Cloud (gcloud) tenga autorización para acceder a tus datos y servicios en Google Cloud:

   gcloud auth login

   Si tienes más de una cuenta, asegúrate de elegir la cuenta que esté en el Google Cloud proyecto en el que se encuentra la API. Si ejecutas gcloud auth list, la cuenta que hayas seleccionado se mostrará como la cuenta activa del proyecto.

4. Para crear una cuenta de servicio, ejecuta el siguiente comando y sustituye SERVICE_ACCOUNT_NAME y My Service Account por el nombre y el nombre visible que quieras usar:

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
      --display-name "My Service Account"

   El comando asigna una dirección de correo a la cuenta de servicio con el siguiente formato:

   SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

   Esta dirección de correo es obligatoria en los comandos posteriores.

5. Crea un archivo de clave de cuenta de servicio:

   gcloud iam service-accounts keys create ~/service-account-creds.json \
      --iam-account SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Añade los roles de gestión de identidades y accesos necesarios:

En esta sección se describen los recursos de gestión de identidades y accesos que usan ESP y ESPv2, así como los roles de gestión de identidades y accesos que necesita la cuenta de servicio asociada para acceder a estos recursos.

Configuración del servicio de endpoint

ESP y ESPv2 llaman a Service Control, que usa la configuración del servicio de endpoint. La configuración del servicio de endpoint es un recurso de gestión de identidades y accesos, y ESP y ESPv2 necesitan el rol Service Controller para acceder a él.

El rol de IAM está en la configuración del servicio de endpoint, no en el proyecto. Un proyecto puede tener varias configuraciones de servicio de endpoint.

Usa el siguiente comando de gcloud para añadir el rol a la cuenta de servicio adjunta en la configuración del servicio de endpoint.

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

Donde
* SERVICE_NAME es el nombre del servicio de endpoint
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com es la cuenta de servicio asociada.

Cloud Trace

ESP y ESPv2 llaman al servicio Cloud Trace para exportar el seguimiento a un proyecto. Este proyecto se llama proyecto de seguimiento. En ESP, el proyecto de seguimiento y el proyecto propietario de la configuración del servicio de endpoint son el mismo. En ESPv2, el proyecto de seguimiento se puede especificar mediante la marca --tracing_project_id y, de forma predeterminada, se usa el proyecto de implementación.

ESP y ESPv2 requieren el rol Agente de Cloud Trace para habilitar Cloud Trace.

Usa el siguiente comando de gcloud para añadir el rol a la cuenta de servicio adjunta:

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

Donde
* TRACING_PROJECT_ID es el ID del proyecto de seguimiento
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com es la cuenta de servicio adjunta. Para obtener más información, consulta ¿Qué son los roles y los permisos?

Consulta gcloud iam service-accounts para obtener más información sobre los comandos.

Desplegar el backend de la API

Hasta ahora, has implementado el documento OpenAPI en Service Management, pero aún no has implementado el código que sirve de backend de la API. En esta sección se explica cómo desplegar contenedores prediseñados para la API de ejemplo y ESP en Kubernetes.

Comprobando los permisos necesarios

Concede los permisos necesarios a la cuenta de servicio asociada a tu clúster:

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member "serviceAccount:SERVICE_ACCOUNT" \
  --role roles/servicemanagement.serviceController

Para obtener más información, consulta ¿Qué son los roles y los permisos?

Proporcionar las credenciales de servicio al ESP

ESP, que se ejecuta en un contenedor, necesita acceder a las credenciales almacenadas localmente en el archivo service-account-creds.json. Para proporcionar acceso a las credenciales a ESP, crea un secreto de Kubernetes y lo monta como un volumen de Kubernetes.

Para crear el secreto de Kubernetes y montar el volumen, sigue estos pasos:

1. Asegúrate de cambiar el nombre del archivo JSON a service-account-creds.json y de copiarlo en endpoints-samples/k8s si se ha descargado en otro directorio. De esta forma, el nombre coincide con las opciones especificadas en el archivo de manifiesto de implementación esp_echo_http.yaml.

2. Asegúrate de que estás en el directorio endpoints-samples/k8s.

3. Crea un secreto de Kubernetes con las credenciales de la cuenta de servicio:

   kubectl create secret generic service-account-creds \
     --from-file=service-account-creds.json
   

   Si la operación se realiza correctamente, se muestra el siguiente mensaje: secret "service-account-creds" created

El archivo de manifiesto de implementación que usas para implementar la API y el ESP en Kubernetes ya contiene el volumen secreto, como se muestra en las dos secciones siguientes del archivo:

volumes:
  - name: service-account-creds
    secret:
      secretName: service-account-creds

volumeMounts:
  - mountPath: /etc/nginx/creds
    name: service-account-creds
    readOnly: true

Configurar el nombre del servicio e iniciarlo

ESP necesita saber el nombre de tu servicio para encontrar la configuración que desplegaste anteriormente (con el comando gcloud endpoints services deploy).

Para configurar el nombre del servicio e iniciarlo, sigue estos pasos:

1. Abre el archivo de manifiesto de la implementación, esp_echo_http.yaml, y sustituye SERVICE_NAME en las opciones de inicio del ESP por el nombre de tu servicio. Es el mismo nombre que configuraste en el campo host de tu documento de OpenAPI. Por ejemplo:

   "--service=echo-api.endpoints.example-project-12345.cloud.goog"

   containers:
     - name: esp
       image: gcr.io/endpoints-release/endpoints-runtime:1
       args: [
         "--http_port", "8080",
         "--backend", "127.0.0.1:8081",
         "--service", "SERVICE_NAME",
         "--rollout_strategy", "managed",
         "--service_account_key", "/etc/nginx/creds/service-account-creds.json",
       ]

   La opción --rollout_strategy=managed" configura ESP para que use la última configuración de servicio implementada. Si especifica esta opción, el ESP detectará el cambio y empezará a usarlo automáticamente en un plazo de 5 minutos después de que implemente una nueva configuración de servicio. Te recomendamos que especifiques esta opción en lugar de un ID de configuración específico para que lo use ESP. Para obtener información sobre las otras opciones de ESP que se usan, consulta Opciones de inicio del ESP.

   Nota: Si usas MiniKube, debes cambiar el campo type del servicio de LoadBalancer a NodePort en el archivo de configuración.
   Nota: Te recomendamos que definas imagePullPolicy en la especificación del contenedor anterior como Always. De esta forma, los pods recién creados siempre extraerán la versión más reciente de ESP. Consulta las prácticas recomendadas de configuración para obtener más información. Cuando se lanza una nueva versión de ESP, puedes realizar un reinicio gradual de todos los pods para asegurarte de que se utiliza la versión más reciente.

2. Inicia el servicio para desplegar el servicio Endpoints en Kubernetes:

   kubectl create -f echo.yaml

   Si aparece un mensaje de error similar al siguiente:

   The connection to the server localhost:8080 was refused - did you specify the right host or port?

   Esto indica que kubectl no está configurado correctamente. Para obtener más información, consulta el artículo sobre cómo configurar kubectl.

Para obtener más información, consulta Implementar endpoints en Kubernetes.

Obtener la dirección IP externa del servicio

Si usas Minikube, ve a la sección Enviar una solicitud mediante una dirección IP.

Pueden pasar unos minutos después de iniciar el servicio en el contenedor antes de que la dirección IP externa esté lista.

Para ver la dirección IP externa del servicio, sigue estos pasos:

1. Ejecuta el siguiente comando:

   kubectl get service

2. Anota el valor de EXTERNAL-IP. Usarás esa dirección IP cuando envíes una solicitud a la API de ejemplo.

Enviar una solicitud mediante una dirección IP

Una vez que la API de ejemplo se esté ejecutando en el clúster de contenedores, podrás enviarle solicitudes.

Crear una clave de API y definir una variable de entorno

El código de ejemplo requiere una clave de API. Para simplificar la solicitud, puedes definir una variable de entorno para la clave de API.

1. En el mismo Google Cloud proyecto que usaste para tu API, crea una clave de API en la página de credenciales de la API. Si quieres crear una clave de API en otro Google Cloud proyecto, consulta el artículo sobre cómo habilitar una API en tu Google Cloud proyecto.

   Ir a la página Credenciales

2. Haz clic en Crear credenciales y, a continuación, selecciona Clave de API.
3. Copia la clave en el portapapeles.
4. Haz clic en Cerrar.
5. En tu ordenador local, pega la clave de API para asignarla a una variable de entorno:
   • En Linux o macOS: export ENDPOINTS_KEY=AIza...
   • En Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Envía la solicitud a minikube.

Los siguientes comandos usan la variable de entorno ENDPOINTS_KEY que has definido anteriormente.

Linux o macOS

NODE_PORT=`kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}'`
MINIKUBE_IP=`minikube ip`
curl --request POST \
    --header "content-type:application/json" \
    --data '{"message":"hello world"}' \
    ${MINIKUBE_IP}:${NODE_PORT}/echo?key=${ENDPOINTS_KEY}

PowerShell

$Env:NODE_PORT=$(kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}')
$Env:MINIKUBE_IP=$(minikube ip)
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://$Env:MINIKUBE_IP:$Env:NODE_PORT/echo?key=$Env:ENDPOINTS_KEY").Content

Enviar la solicitud a otros clústeres de Kubernetes

Linux o macOS

Usa curl para enviar una solicitud HTTP mediante la variable de entorno ENDPOINTS_KEY que has definido anteriormente. Sustituye IP_ADDRESS por la dirección IP externa de tu instancia.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

En los curl anteriores:

• La opción --data especifica los datos que se van a enviar a la API.
• La opción --header especifica que los datos están en formato JSON.

PowerShell

Usa Invoke-WebRequest para enviar una solicitud HTTP mediante la variable de entorno ENDPOINTS_KEY que has definido anteriormente. Sustituye IP_ADDRESS por la dirección IP externa de tu instancia.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

En el ejemplo anterior, las dos primeras líneas terminan en una comilla inversa. Cuando pegues el ejemplo en PowerShell, asegúrate de que no haya ningún espacio después de las comillas inversas. Para obtener información sobre las opciones que se usan en la solicitud de ejemplo, consulta Invoke-WebRequest en la documentación de Microsoft.

Aplicación de terceros

Puedes usar una aplicación de terceros, como la extensión Postman del navegador Chrome, para enviar la solicitud:

• Selecciona POST como verbo HTTP.
• En el encabezado, selecciona la clave content-type y el valor application/json.
• En el cuerpo, introduce lo siguiente:
  {"message":"hello world"}
• En la URL, usa la clave de API real en lugar de la variable de entorno. Por ejemplo:
  http://192.0.2.0:80/echo?key=AIza...

La API devuelve el mensaje que envías y responde con lo siguiente:

{
  "message": "hello world"
}

Si no has recibido una respuesta correcta, consulta el artículo Solucionar problemas de errores de respuesta.

Acabas de desplegar y probar una API en Endpoints.

Nota: Si quieres decirnos qué te ha gustado de este tutorial, puedes enviarnos tus comentarios en la parte inferior de esta página. Tus comentarios nos ayudan a mejorar estos tutoriales.
Si has recibido un error, únete al google-cloud-endpoints grupo de Google e infórmanos de lo que ha ido mal. Este grupo recibe respuestas de otros usuarios de Endpoints y de ingenieros de Google, que monitorizan el grupo.

Monitorizar la actividad de la API

Para monitorizar la actividad de la API, siga estos pasos:

1. Consulta los gráficos de actividad de tu API en la página Endpoints > Services (Endpoints > Servicios).
   

   Ir a la página Servicios de Endpoints

   
   La solicitud puede tardar unos instantes en reflejarse en los gráficos.

2. Consulta los registros de solicitudes de tu API en la página Explorador de registros.
   

   Ir a la página Explorador de registros

Configurar DNS para Endpoints

Como el nombre del servicio Endpoints de la API está en el dominio .endpoints.YOUR_PROJECT_ID.cloud.goog, puedes usarlo como nombre de dominio completo (FQDN) haciendo un pequeño cambio de configuración en el archivo openapi.yaml. De esta forma, puedes enviar solicitudes a la API de ejemplo mediante echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog en lugar de la dirección IP.

Para configurar el DNS de Endpoints, sigue estos pasos:

1. Abre el archivo de configuración de OpenAPI, openapi.yaml, y añade la propiedad x-google-endpoints en el nivel superior del archivo (sin sangría ni anidación), como se muestra en el siguiente fragmento:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"

2. En la propiedad name, sustituye YOUR_PROJECT_ID por el ID de tu proyecto.
3. En la propiedad target, sustituya IP_ADDRESS por la dirección IP que usó cuando envió una solicitud a la API de ejemplo.
4. Despliega el archivo de configuración de OpenAPI actualizado en Service Management:

   gcloud endpoints services deploy openapi.yaml
   

Por ejemplo, supongamos que el archivo openapi.yaml tiene la siguiente configuración:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Cuando implementas el archivo openapi.yaml con el comando gcloud anterior, Service Management crea un registro A de DNS, echo-api.endpoints.my-project-id.cloud.goog, que se resuelve en la dirección IP de destino, 192.0.2.1. La nueva configuración de DNS puede tardar unos minutos en propagarse.

Configurar SSL

Para obtener más información sobre cómo configurar DNS y SSL, consulta Habilitar SSL para endpoints.

Enviar una solicitud al FQDN

Ahora que has configurado el registro DNS de la API de ejemplo, envíale una solicitud mediante el FQDN (sustituye YOUR_PROJECT_ID por el ID de tu proyecto) y la variable de entorno ENDPOINTS_KEY que has definido anteriormente:

• En Linux o macOS:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• En Windows PowerShell:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content