Ejemplo: API REST de Reports
En este ejemplo se muestra cómo utilizar la API REST de Reports de operaciones de nube para generar informes de uso para una suscripción de nube.
El ejemplo pasa por la recuperación de una lista de medidas disponibles para la suscripción en la nube y después por la generación de un informe para
una medida y un periodo de tiempo específicos.
- Antes de empezar
- Todas las llamadas a la API requieren un token válido de solicitud de falsificación de sitios cruzados (CSRF) en la cabecera IBM® -CSRF-TOKEN de la llamada. Obtenga una señal CSRF mediante
POST /instance/services/csrf_token. Para obtener más información, consulte Cómo evitar la falsificación de solicitudes entre sitios. - Recuperar medidas
- Utilice la llamada siguiente para visualizar una lista de credenciales de cliente para la suscripción en la nube:
Se devuelve una lista de medidas. La lista incluye el nombre y el ámbito de la medida. El ámbito indica si la medida está disponible para todos los entornos o solo para entornos específicos.GET /instance/services/metrics - Generar un informe
- A continuación puede elegir la medida en la que está interesado, por ejemplo, el número máximo de usuarios simultáneos para un día específico.
Siempre debe incluir un día de inicio en la llamada. Si no incluye un entorno, la llamada devuelve datos de uso para todos los entornos. Si desea filtrar el informe para mostrar los datos de uso para un entorno específico, como el entorno de desarrollo, añada el parámetro environment a la llamada:GET /instance/services/reports?start_day=2019_01_01&metric=maximum_concurrent_users
Si desea ver datos de uso, por ejemplo para 30 días a partir de la fecha de inicio, modifique la llamada de la manera siguiente:GET /instance/services/reports?start_day=2019_01_01&metric=maximum_concurrent_users&environment=dev
Si está interesado en el periodo de 30 días anterior a la fecha de inicio, utilice un valor negativo para el parámetro days:GET /instance/services/reports?start_day=2019_01_01&days=30&metric=maximum_concurrent_users&environment=devGET /instance/services/reports?start_day=2019_01_01&days=-30&metric=maximum_concurrent_users&environment=dev