Beispiel: REST-API Reports

Dieses Beispiel zeigt, wie die REST-API Reports für Cloudoperationen zum Generieren von Nutzungsberichten für eine Cloudsubskription verwendet wird.

Das Beispiel enthält Informationen zum Abrufen einer Liste von Messwerten, die für die Cloudsubskription verfügbar sind, und anschließend zur Generierung eines Berichts für einen bestimmten Messwert und einen bestimmten Zeitraum.
Vorbereitende Schritte
Alle API-Aufrufe erfordern ein gültiges CSRF-Token (Cross Site Forgery Request) im IBM® -CSRF-TOKEN-Header des Aufrufs. Sie können ein CSRF-Token mithilfe von POST /instance/services/csrf_token abrufen. Weitere Informationen finden Sie unter Cross Site Request Forgery verhindern.
Messwerte abrufen
Verwenden Sie den folgenden Aufruf, um eine Liste von Messwerten anzuzeigen, die für die Cloudsubskription verfügbar sind:
GET /instance/services/metrics
Eine Liste von Messwerten wird zurückgegeben. Die Liste enthält den Namen und den Geltungsbereich des Messwerts. Der Geltungsbereich gibt an, ob der Messwert für alle oder nur für bestimmte Umgebungen verfügbar ist.
Bericht generieren
Sie können den gewünschten Messwert auswählen, z. B. die maximale Anzahl gleichzeitig angemeldeter Benutzer für einen bestimmten Tag:
GET /instance/services/reports?start_day=2019_01_01&metric=maximum_concurrent_users
Sie müssen bei dem Aufruf immer einen Starttag angeben. Wenn Sie keine Umgebung angeben, gibt der Aufruf Verwendungsdaten für alle Umgebungen zurück. Wenn Sie den Bericht filtern möchten, um die Nutzungsdaten für eine bestimmte Umgebung, z. B. die Entwicklungsumgebung, anzuzeigen, fügen Sie dem Aufruf den Parameter environment hinzu:
GET /instance/services/reports?start_day=2019_01_01&metric=maximum_concurrent_users&environment=dev
Wenn Sie die Verwendungsdaten z. B. für einen Zeitraum von 30 Tagen ab Startdatum anzeigen möchten, ändern Sie den Aufruf wie folgt:
GET /instance/services/reports?start_day=2019_01_01&days=30&metric=maximum_concurrent_users&environment=dev
Wenn Sie an dem 30-Tage-Zeitraum vor dem Startdatum interessiert sind, verwenden Sie einen negativen Wert für den Parameter days:
GET /instance/services/reports?start_day=2019_01_01&days=-30&metric=maximum_concurrent_users&environment=dev