Creación, configuración y prueba de planes de uso con la CLI y la API de REST de API Gateway

Para crear un plan de uso con la API de REST

1. Llame a usageplan:create para crear un plan de uso. En la carga, especifique el nombre y la descripción del plan, las etapas de API asociadas, los límites de velocidad y las cuotas.

   Anote el identificador del plan de uso resultante. Lo necesitará en el siguiente paso.

2. Aplique alguna de las siguientes acciones:

   1. Llame a usageplankey:create para agregar una clave de API al plan de uso. Especifique keyId y keyType en la carga.

      Para agregar más claves de API al plan de uso, repita la llamada anterior usando una clave de API cada vez.

   2. Llame a apikey:import para agregar una o varias claves de API directamente al plan de uso especificado. La carga de solicitudes debe incluir los valores de las claves de API, el identificador del plan de uso asociado, los indicadores booleanos que indican que las claves están habilitadas para el plan de uso y, posiblemente, los nombres y descripciones de las claves de API.

      En el siguiente ejemplo de la solicitud apikey:import, se agregarán tres claves de API (identificadas mediante key, namey description) a un plan de uso (identificado mediante usageplanIds):

      POST /apikeys?mode=import&format=csv&failonwarnings=fase HTTP/1.1
      Host: apigateway.us-east-1.amazonaws.com
      Content-Type: text/csv
      Authorization: ...
      
      key,name, description, enabled, usageplanIds
      abcdef1234ghijklmnop8901234567, importedKey_1, firstone,  tRuE, n371pt 
      abcdef1234ghijklmnop0123456789, importedKey_2, secondone, TRUE, n371pt
      abcdef1234ghijklmnop9012345678, importedKey_3,          , true, n371pt
      

      Como resultado, se crearán tres recursos UsagePlanKey y se agregarán a UsagePlan.

      También puede añadir claves de API a varios planes de uso de esta manera. Para ello, cambie cada valor de la columna usageplanIds por una cadena separada por comas que contenga los identificadores del plan de uso seleccionado entre comillas ("n371pt,m282qs" o 'n371pt,m282qs').

      nota

      Una clave de API se puede asociar a más de un plan de uso. Un plan de uso se puede asociar a más de una etapa. Sin embargo, una clave de API determinada solo se puede asociar a un plan de uso para cada etapa de la API.

Para probar su plan de uso

• Realice una solicitud GET en el recurso Pets (/pets), con los parámetros de consulta ?type=...&page=... de la API (por ejemplo, xbvxlpijch) en un plan de uso:

  GET /testStage/pets?type=dog&page=1 HTTP/1.1
  x-api-key: Hiorr45VR...c4GJc
  Content-Type: application/x-www-form-urlencoded
  Host: xbvxlpijch.execute-api.ap-southeast-1.amazonaws.com
  X-Amz-Date: 20160803T001845Z
  Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160803/ap-southeast-1/execute-api/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-api-key, Signature={sigv4_hash}
  

  nota

  Debe enviar esta solicitud al componente execute-api de la API Gateway y proporcionar la clave de API necesaria (por ejemplo, Hiorr45VR...c4GJc) en el encabezado x-api-key correspondiente.

  La respuesta, si se ejecuta correctamente, devuelve un código de estado 200 OK y una carga que contiene los resultados solicitados del backend. Si olvidó establecer el encabezado x-api-key o lo estableció con una clave incorrecta, obtendrá una respuesta 403 Forbidden. Sin embargo, si no configuró el método para que solicite una clave de API, probablemente obtendrá una respuesta 200 OK tanto si estableció el encabezado x-api-key correctamente como si no, y las limitaciones de solicitudes y los límites de cuota del plan de uso se omitirán.

  Ocasionalmente, cuando se produce un error interno que impide a API Gateway imponer limitaciones controladas en el plan de uso o límites de cuota en la solicitud, API Gateway proporciona la solicitud sin aplicar los límites ni las cuotas especificados en el plan de uso. Sin embargo, registra un mensaje de error Usage Plan check failed due to an internal error en CloudWatch. Puede obviar este tipo de errores ocasionales.