Creación, configuración y prueba de los planes de uso con la consola de API Gateway

Antes de crear un plan de uso, asegúrese de que ha configurado las claves de API que desea. Para obtener más información, consulte Configuración de claves de API mediante la consola de API Gateway.

En esta sección se describen los pasos necesarios para crear y utilizar un plan de uso a través de la consola de API Gateway.

Migrar la API a planes de uso predeterminados (si es necesario)

Si comenzó a utilizar API Gateway después del 11 de agosto de 2016 (fecha en la que se implementó la característica de planes de uso), los planes de uso estarán habilitados de forma predeterminada en todas las regiones compatibles.

Si comenzó a utilizar API Gateway antes de dicha fecha, es posible que tenga que migrar a planes de uso predeterminados. Se le solicitará la opción Enable Usage Plans (Habilitar planes de uso) antes de utilizar los planes de uso por primera vez en la región seleccionada. Cuando habilite esta opción, dispondrá de planes de uso predeterminados para cada etapa de API asociada con las claves de API existentes. En el plan de uso predeterminado, no se establece inicialmente ningún límite de cuota o limitación y las asociaciones entre las claves de la API y las etapas de la API se copian en los planes de uso. La API se comportará igual que antes. Sin embargo, debe utilizar la propiedad apiStages de UsagePlan para asociar los valores de la etapa de la API especificados (apiId y stage) con las claves de la API incluidas (mediante UsagePlanKey), en lugar de utilizar la propiedad stageKeys de ApiKey.

Para comprobar si ya se ha migrado a planes de uso predeterminados, utilice el comando get-account de la CLI. En la salida del comando, la lista features incluye una entrada de "UsagePlans" cuándo los planes de uso están habilitados.

También puede migrar sus API a planes de uso predeterminados utilizando la AWS CLI tal y como se indica a continuación:

Para migrar a planes de uso predeterminados mediante la AWS CLI

1. Llame a este comando de la CLI: update-account.

2. Para el parámetro cli-input-json, utilice el siguiente JSON:

   [
       {
           "op": "add",
           "path": "/features",
           "value": "UsagePlans"
       }
   ]

Crear un plan de uso

El siguiente procedimiento describe cómo crear un plan de uso.

Para crear un plan de uso

1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

2. En el panel de navegación principal de API Gateway, elija Planes de uso y, a continuación, elija Crear plan de uso.

   

3. En Nombre, ingrese un nombre.

4. (Opcional) En Description (Descripción), introduzca una descripción.

5. De forma predeterminada, los planes de uso habilitan la limitación. Ingrese una tasa y una ráfaga para el plan de uso. Elija Limitación para desactivar la limitación.

6. De forma predeterminada, los planes de uso habilitan una cuota durante un periodo de tiempo. En Solicitudes, ingrese el número total de solicitudes que un usuario puede realizar en el periodo de tiempo del plan de uso. Elija Cuota para desactivar la cuota.

7. Elija Crear plan de uso.

Para agregar una etapa al plan de uso

1. Seleccione el plan de uso.

2. En la pestaña Etapas asociadas, elija Agregar etapa.

   

3. En API, seleccione una API.

4. En Etapa, seleccione una etapa.

5. (Opcional) Para activar la regulación en el nivel de método, haga lo siguiente:

   1. Elija Limitación en el nivel de método y, a continuación, elija Agregar método.

   2. En Recurso, seleccione un recurso de la API.

   3. En Método, seleccione un método de la API.

   4. Ingrese una tasa y una ráfaga para el plan de uso.

6. Elija Agregar al plan de uso.

Para agregar una clave al plan de uso

1. En la pestaña Claves de API asociadas, elija Agregar clave de API.

   

2. 1. Para asociar una clave existente al plan de uso, seleccione Agregar clave existente y, a continuación, seleccione la clave existente en el menú desplegable.

   2. Para crear una clave de API nueva, seleccione Crear y agregar una clave nueva y, a continuación, cree una clave nueva. Para obtener más información sobre cómo crear una clave nueva, consulte Crear una clave de API.

3. Elija Agregar clave de la API.

Probar un plan de uso

Para probar el plan de uso, puede utilizar un SDK de AWS, la AWS CLI o un cliente de API de REST como Postman. Para ver un ejemplo de uso de Postman para probar el plan de uso, consulte Probar planes de uso.

Mantenimiento de un plan de uso

El mantenimiento de un plan de uso implica monitorear las cuotas usadas y restantes durante un período de tiempo determinado, si es necesario, y ampliar las cuotas restantes en una cantidad específica. Los siguientes procedimientos describen cómo monitorear las cuotas.

Para monitorear las cuotas usadas y restantes

1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

2. En el panel de navegación principal de API Gateway, elija Planes de uso.

3. Seleccione un plan de uso.

4. Elija la pestaña Claves de API asociadas para ver el número de solicitudes pendientes de cada clave durante el periodo de tiempo.

5. (Opcional) Elija Exportar datos de uso y, a continuación, elija una fecha de inicio y una fecha de finalización. A continuación, elija JSON o CSV como formato de datos exportados y, a continuación, elija Exportar.

   El siguiente ejemplo muestra un archivo exportado.

   {
     "thisPeriod": {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     },
     "startDate": "2016-08-01",
     "endDate": "2016-08-03"
   }

   Los datos de uso del ejemplo representan los datos de uso diario de un cliente de API identificado por la clave de API (px1KW6...qBazOJH), entre el 1 de agosto de 2016 y el 3 de agosto de 2016. Cada dato de uso diario muestra las cuotas usadas y restantes. En este ejemplo, el suscriptor aún no ha utilizado ninguna de las cuotas asignadas y el propietario o administrador de la API redujo la cuota restante de 5000 a 10 durante el tercer día.

Los siguientes procedimientos describen cómo modificar las cuotas.

Para ampliar las cuotas restantes

1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

2. En el panel de navegación principal de API Gateway, elija Planes de uso.

3. Seleccione un plan de uso.

4. Elija la pestaña Claves de API asociadas para ver el número de solicitudes pendientes de cada clave durante el periodo de tiempo.

5. Seleccione una clave de API y, a continuación, elija Conceder extensión de uso.

6. Escriba un número para la cuota de las solicitudes restantes. Puede aumentar las solicitudes de cambio de nombre o reducir las solicitudes restantes durante el periodo de tiempo del plan de uso.

7. Elija Actualizar cuota.