Diagnostic Logs - List

Referenz

Dienst:: Notification

API-Version:: 7.1

Dient zum Abrufen einer Liste der Diagnoseprotokolle für diesen Dienst.

GET https://{service}dev.azure.com/{organization}/_apis/notification/diagnosticlogs/{source}/entries/{entryId}?api-version=7.1

Mit optionalen Parametern:

GET https://{service}dev.azure.com/{organization}/_apis/notification/diagnosticlogs/{source}/entries/{entryId}?startTime={startTime}&endTime={endTime}&api-version=7.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
source	path	True	string (uuid)	ID, die angibt, auf welche Art von Protokollen die Diagnose überprüft werden soll.
entryId	path		string (uuid)	Die ID des spezifischen zu abfragenden Protokolls.
organization	path		string	Der Name der Azure DevOps-Organisation.
service	path		string	Der Dienst, an den diese Anforderung weitergeleitet wird.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
endTime	query		string (date-time)	Endzeit für den zu abfragenden Zeitraum.
startTime	query		string (date-time)	Startzeit für den Zuabfragezeitbereich.

Antworten

Name	Typ	Beschreibung
200 OK	INotificationDiagnosticLog[]	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Bereiche

Name	Beschreibung
vso.notification_diagnostics	Bietet Zugriff auf Benachrichtigungs-bezogene Diagnoseprotokolle und bietet die Möglichkeit, die Diagnose für einzelne Abonnements zu aktivieren.

Beispiele

Beispielanforderung

HTTP

GET https://dev.azure.com/_apis/notification/diagnosticlogs/{source}/entries?startTime=2019-08-08T10:56:23.7996492&endTime=2019-08-08T14:56:23.7996492&api-version=7.1

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 1,
  "value": [
    {
      "batches": [
        {
          "startTime": "14:24:03.2251514",
          "endTime": "14:24:05.3593469",
          "notificationIds": "8, 10",
          "notificationCount": 2,
          "problematicNotifications": []
        }
      ],
      "result": "Succeeded",
      "stats": {
        "timings": {
          "NotificationSql": 7,
          "PreDelivery": 1,
          "Filter": 242,
          "Identity": 0,
          "NotificationDeliveryTimeAverage": 904,
          "NotificationDeliveryTimeAttempts": 2
        },
        "All": {
          "read": 2,
          "attempted": 2,
          "succeeded": 2,
          "failed": 0,
          "failedAlertable": 0,
          "failedNonAlertable": 0,
          "failedRetryable": 0,
          "recipientCount": 2,
          "Delivered": 2
        },
        "WorkItemChangedEvent": {
          "read": 2,
          "attempted": 2,
          "succeeded": 2,
          "failed": 0,
          "failedAlertable": 0,
          "failedNonAlertable": 0,
          "failedRetryable": 0,
          "recipientCount": 2,
          "Delivered": 2
        },
        "EmailCounters": {
          "emailProcessed": 2,
          "emailStarted": 2,
          "emailDelivered": 2,
          "emailAttemptedMessages": 2,
          "emailDeliveredMessages": 2,
          "emailAttemptedRecipients": 2,
          "emailDeliveredRecipients": 2
        },
        "EmailTimings": {
          "AllSendMailAverage": 681,
          "AllSendMailAttempts": 2,
          "SucceededSendMailAverage": 681,
          "SucceededSendMailAttempts": 2,
          "FailedSendMailAverage": 0,
          "FailedSendMailAttempts": 0,
          "Subscriber": 67,
          "TemplateFetch": 88,
          "Transform": 240
        }
      },
      "logType": "NotificationDelivery",
      "source": "631f49b3-46e1-42ec-8fff-081bd176c18a",
      "id": "cc8dcfb2-ee7d-4776-b0bb-df5b9b9bb797",
      "startTime": "2019-08-08T14:24:03.1901508Z",
      "endTime": "2019-08-08T14:24:05.3853457Z",
      "description": "WorkItem User Delivery",
      "warnings": 0,
      "errors": 0,
      "activityId": "dff0b99f-c7c2-4a30-b944-574c362ec15f",
      "properties": {
        "JobTimeSlice": "300000",
        "JobTimeoutMultiple": "12",
        "JobRestartDelay": "30",
        "ProcessingJobDelaySeconds": "10",
        "MaxConcurrentInstances": "5",
        "InstancesExceededRescheduleDelaySeconds": "30000",
        "RerunNotificationJobDelaySecs": "30000",
        "ContributionFallbackModeRescheduleDelaySeconds": "60000",
        "OrganizationAadTenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
        "EventingEnabled": "True",
        "FailedRetryInterval": "300",
        "NotificationBatchSize": "100",
        "NotificationStatFlushFrequency": "5",
        "CoreDeliveryStartDelay": "10",
        "EmailEnabled": "True",
        "MaxMailSenders": "8",
        "MaxMailRecipients": "90",
        "AsciiOnlyEmailAddresses": "True",
        "Feature: NotificationJob.DisablePlainTextEmail": "True",
        "HostName": "fabrikam",
        "SendingDomain": "dev.azure.com",
        "NextProcessTime": "12/31/9999 11:59:59 PM"
      },
      "messages": [
        {
          "level": 3,
          "time": "14:24:05.3803456",
          "message": "Previous job run succeeded."
        },
        {
          "level": 3,
          "time": "14:24:05.3803456",
          "message": "Current job run succeeded - consecutive successes: 1"
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
INotificationDiagnosticLog	Abstraktionsschnittstelle für das Diagnoseprotokoll. In erster Linie für die Deserialisierung.
NotificationDiagnosticLogMessage

INotificationDiagnosticLog

Objekt

Abstraktionsschnittstelle für das Diagnoseprotokoll. In erster Linie für die Deserialisierung.

Name	Typ	Beschreibung
activityId	string (uuid)	Bezeichner, der zum Korrelieren mit anderen Diagnosen verwendet wird, die möglicherweise an anderer Stelle aufgezeichnet wurden.
description	string	Beschreibung, welcher Abonnement- oder Benachrichtigungsauftrag protokolliert wird.
endTime	string (date-time)	Zeitpunkt, zu dem das Protokoll beendet wurde.
id	string (uuid)	Eindeutiger Instanzbezeichner.
logType	string	Art der protokollierten Informationen.
messages	NotificationDiagnosticLogMessage[]	Liste der Protokollnachrichten.
properties	object	Wörterbuch der Protokolleigenschaften und -einstellungen für den Auftrag.
source	string (uuid)	Dieser Bezeichner hängt vom logType ab. Bei Benachrichtigungsaufträgen ist dies die Auftrags-ID. Bei der Abonnementablaufverfolgung ist dies eine spezielle Stamm-GUID mit der abonnement-ID codiert.
startTime	string (date-time)	Zeitpunkt, zu dem das Protokoll gestartet wurde.

NotificationDiagnosticLogMessage