Obtenir un flux de journaux par id

Récupérer la configuration et le statut d’un flux de journal.

Exemples de réponses

Flux de journal Amazon EventBridge

{
  "id": "string",
  "name": "string",
  "type": "eventbridge",
  "status": "active|paused|suspended",
  "sink": {
    "awsAccountId": "string",
    "awsRegion": "string",
    "awsPartnerEventSource": "string"
  }
}

Flux de journal HTTP

{
  "id": "string",
  "name": "string",
  "type": "http",
  "status": "active|paused|suspended",
  "sink": {
    "httpContentFormat": "JSONLINES|JSONARRAY",
    "httpContentType": "string",
    "httpEndpoint": "string",
    "httpAuthorization": "string"
  }
}

Flux de journal Datadog

{
  "id": "string",
  "name": "string",
  "type": "datadog",
  "status": "active|paused|suspended",
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

Mixpanel

Requête :

{
  "name": "string",
  "type": "mixpanel",
  "sink": {
    "mixpanelRegion": "string",
    "mixpanelProjectId": "string",
    "mixpanelServiceAccountUsername": "string",
    "mixpanelServiceAccountPassword": "string"
  }
}

Réponse :

{
  "id": "string",
  "name": "string",
  "type": "mixpanel",
  "status": "active",
  "sink": {
    "mixpanelRegion": "string",
    "mixpanelProjectId": "string",
    "mixpanelServiceAccountUsername": "string",
    "mixpanelServiceAccountPassword": "string"
  }
}

Segment

Requête :

{
  "name": "string",
  "type": "segment",
  "sink": {
    "segmentWriteKey": "string"
  }
}

Réponse :

{
  "id": "string",
  "name": "string",
  "type": "segment",
  "status": "active",
  "sink": {
    "segmentWriteKey": "string"
  }
}

Flux de journal Splunk

{
  "id": "string",
  "name": "string",
  "type": "splunk",
  "status": "active|paused|suspended",
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

Flux de journal Sumo Logic

{
  "id": "string",
  "name": "string",
  "type": "sumo",
  "status": "active|paused|suspended",
  "sink": {
    "sumoSourceAddress": "string"
  }
}

Statut

Le status d’un flux de journal peut prendre l’une des valeurs suivantes :

1. active - Le flux est actuellement activé.
2. paused - Le flux est actuellement désactivé par l’utilisateur et ne tentera pas de transmettre les journaux.
3. suspended - Le flux est actuellement désactivé en raison d’erreurs et ne tentera pas de transmettre les journaux.

GET https://{tenantDomain}/api/v2/log-streams/{id}

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.LogStreams.Get(
        context.TODO(),
        "id",
    )
}

200

{
  "filters": [
    {}
  ],
  "id": "<string>",
  "isPriority": true,
  "name": "<string>",
  "pii_config": {
    "log_fields": []
  },
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

L’id du flux de journal à récupérer

Réponse

200

application/json

Flux de journal renvoyé.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

filters · object[]

Seuls les événements de journal correspondant à ces filtres seront transmis par le flux. S’ils sont omis ou vides, tous les événements seront transmis.

Show child attributes

id · string<log-stream-id>

L’id du flux de journal

isPriority · boolean

Vrai pour les flux de journal prioritaires; faux pour les flux non prioritaires

name · string

nom du flux de journal

pii_config · object

Show child attributes

sink · object

Show child attributes

status · enum<string>

Le statut du flux de journal. Valeurs possibles : active, paused, suspended

Options disponibles: active, paused, suspended

type · enum<string>

Options disponibles: http