Publicado originalmente el 25 de octubre de 2019
Sobre la base de los comentarios de nuestro Anuncio de registro de tarifas de API Aquí hay un artículo de seguimiento que contiene una serie de preguntas que hemos recibido comúnmente de clientes y socios. Tenga en cuenta que a medida que recibamos más preguntas y más respuestas, actualizaremos el contenido de este artículo.
Q. ¿A qué nivel se aplicará la limitación de velocidad de API? ¿Es por instancia? ¿Por organización? ¿Por aplicación API?
Un. Aplicaremos la limitación de velocidad de API en el Aplicación API nivel. Para mayor claridad, una aplicación de API se relaciona con cada aplicación que se crea y mantiene dentro de la organización de Brightspace. Herramienta de administración de extensibilidad. A cada aplicación de administración de extensibilidad habilitada en un sitio de Brightspace se le asignará su propio depósito en silos de créditos de API.
Q. ¿Cuál será el tamaño del bucket del límite de velocidad de la API?
Un. El tamaño del bucket del límite de velocidad es 50,000 créditos API por minuto. Tenga en cuenta que incluimos lo siguiente en cada encabezado de respuesta de API:
X-Tasa-Límite-Restante - Este valor proporciona al desarrollador el número restante de créditos disponibles dentro del período de tiempo proporcionado. NOTA: este valor solo será significativo en los sitios en los que la limitación de velocidad de API esté activada.
Q. ¿Publicará los costos de los tokens por ruta de API?
Un. A partir del 3 de diciembre de 2019, los costos del token de ruta se establecen en 10 créditos por llamada a la API.
A medida que monitoreamos y analizamos los registros de uso de la API, podremos comprender mejor los costos reales del servidor de nuestras rutas de API. El resultado de esto es que queremos reservarnos el derecho de cambiar los costos de los tokens de ruta de la API. Anticipamos que los costos de las rutas de API cambiarán antes del lanzamiento completo del producto en mayo de 2020.
Incluimos lo siguiente en cada encabezado de respuesta de API:
X-Costo-Solicitud - este valor informa al desarrollador de la cantidad de créditos que cuesta la ruta de API actual. En este momento, este valor siempre será 10.
Q. ¿Habrá alguna forma de saber si una de mis aplicaciones ha superado el límite de velocidad de la API (un mensaje 429)?
R. Sí. Estos datos estarán disponibles a través de Brightspace Registro del sistema. Estos datos se conservarán en el registro del sistema en función de las reglas de retención de datos actuales. Buscar "La ruta alcanzó un límite de velocidad" para buscar eventos de límite de velocidad (429 mensajes).
Q. ¿Habrá alguna forma de saber si una de mis aplicaciones ha activado un registro de tasas de API?
R. Sí. A partir de la versión de diciembre del producto, estos datos estarán disponibles a través de Brightspace Registro del sistema. Estos datos se conservarán en el registro del sistema en función de las reglas de retención de datos actuales. Busque "Ruta alcanzó un límite de registro" para encontrar registros de registro de límite de velocidad. En el caso de los sistemas que tienen activada la limitación de velocidad de API, busque en el registro del sistema "La ruta alcanzó un límite excesivo" para identificar los eventos de límite de velocidad (errores 429).
Q. ¿La limitación de velocidad de API incluirá llamadas a servicios LTI?
R. Sí. Todas las llamadas de servicio de LTI Advantage están sujetas a la misma limitación de velocidad que nuestras API del marco de aprendizaje de Brightspace.
Q. ¿Habrá algún indicador disponible para informar a un desarrollador de que se está acercando a agotar su depósito de límite de tasa de API?
R. Sí. El X-Tasa-Límite-Restante value informa a un desarrollador sobre cuántos créditos le quedan para usar dentro del marco de tiempo de minutos actual.
Q. ¿Habrá alguna forma de saber cuánto tiempo queda hasta que se recargue mi depósito de crédito API?
R. Sí. Incluimos el siguiente campo en nuestro encabezado de respuesta:
Restablecimiento del límite de velocidad X - Este valor proporciona a un desarrollador la cantidad de tiempo, en segundos, hasta que se restablezca su bucket.
Q. Acabo de recibir un mensaje 429. ¿Cómo sabré cuánto tiempo tengo que esperar hasta que se recargue mi depósito de crédito API?
Un. Para las respuestas 429, incluimos un valor de respuesta de encabezado estándar de la industria:
Reintentar después - Este valor proporciona a un desarrollador la cantidad de tiempo, en segundos, hasta que se restablezca su bucket.
Q. ¿Será posible comprar créditos adicionales o un grupo de créditos más grande?
R. No. Creemos que la cantidad de créditos disponibles por minuto refleja una cantidad de uso aceptable.
Q. Me preocupa que mi aplicación supere los límites proporcionados y que mi código no esté listo para manejar mensajes 429. ¿Qué puedo hacer?
Un. Con nuestro anuncio inicial en octubre de 2019, en D2L creemos que hemos proporcionado una cantidad significativa de tiempo de preparación para los clientes. Animamos a todos los clientes a trabajar con su D2L TAM y/o CSM para prepararse para este cambio. En D2L estamos más que felices de interactuar con usted sobre cómo la limitación de velocidad de API puede afectar el código existente que ha escrito.
Nuestro objetivo con esta iniciativa es mantener el rendimiento y la estabilidad de su inversión en Brightspace. Hemos creado la solución de tal manera que podemos administrar las exenciones donde sea necesario, pero queremos evitar conceder estas excepciones en la medida de lo posible. Si cree que necesita una exención, comuníquese con su D2L CSM y/o TAM para que podamos trabajar juntos para decidir un camino de mutuo acuerdo a seguir.
Q. ¿Las llamadas a la API incorrectas (por ejemplo, 400, 403, 404) le cuestan créditos a mi aplicación?
R. Sí. La lógica de limitación de velocidad se produce antes de que procesemos la llamada a la API. En el momento en que recibimos la llamada, no sabemos si tendrá éxito o no.