Prueba de planes de uso para API de REST en API Gateway

A modo de ejemplo, vamos a utilizar la API PetStore, que se creó en Tutorial: Crear una API de REST importando un ejemplo. Supongamos que la API está configurada para utilizar una clave de API de Hiorr45VR...c4GJc. Los siguientes pasos describen cómo probar un plan de uso.

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.