Mantenimiento de un plan de uso para las API de REST en API Gateway

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.

AWS Management Console

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.

   {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     }

   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.

AWS CLI

Los siguientes ejemplos update-usage-plan permiten agregar, quitar o modificar la configuración de limitación de nivel de método en un plan de uso.

nota

Asegúrese de cambiar us-east-1 al valor de región adecuado para la API.

Para agregar o sustituir un límite de frecuencia a fin de limitar de forma controlada un recurso y un método individuales:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/rateLimit",value="0.1"

Para agregar o sustituir un límite de ráfaga a fin de limitar de forma controlada un recurso y un método individuales:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/burstLimit",value="1"

Para quitar la configuración de limitación controlada de nivel de método para un recurso y un método individuales:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod",value=""

Para quitar toda la configuración de limitación controlada de nivel de método para una API:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle ",value=""

A continuación se muestra un ejemplo con la API de ejemplo PetStore:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle",value='"{\"/pets/GET\":{\"rateLimit\":1.0,\"burstLimit\":1},\"//GET\":{\"rateLimit\":1.0,\"burstLimit\":1}}"'

REST API

Llame a usageplan:update para mantener un plan de uso.