id でログストリームを更新

ログストリームを更新します。

PATCH エンドポイントの使用例

PATCH 操作では、次のフィールドを更新できます。

• name
• status
• sink

注: eventbridge 型および eventgrid 型のログストリームでは、sink の更新は許可されません。

ログストリームのステータスを更新する

{
  "status": "active|paused"
}

ログストリームの名前を更新する

{
  "name": "string"
}

http 型のストリームの sink プロパティを更新する

{
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONARRAY|JSONLINES",
    "httpAuthorization": "string"
  }
}

datadog 型のストリームの sink プロパティを更新する

{
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

splunk 型のストリームの sink プロパティを更新する

{
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

sumo 型のストリームの sink プロパティを更新する

{
  "sink": {
    "sumoSourceAddress": "string"
  }
}

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

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.UpdateLogStreamRequestContent{}
    client.LogStreams.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

取得するログストリームの id

ボディ

application/jsonapplication/x-www-form-urlencoded

filters · object[]

これらのフィルターに一致するログイベントのみがこのストリームから配信されます。省略されているか空の場合は、すべてのイベントが配信されます。

Show child attributes

isPriority · boolean

優先ログストリームの場合は true、非優先の場合は false。

name · string

log stream 名

pii_config · object

Show child attributes

sink · object

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

status · enum<string>

ログストリームの status。指定可能な値: active、paused、suspended

利用可能なオプション: active, paused, suspended

レスポンス

200

application/json

ログストリームが更新されました

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

filters · object[]

これらのフィルターに一致するログイベントのみがストリームから配信されます。省略した場合、または空の場合は、すべてのイベントが配信されます。

Show child attributes

id · string<log-stream-id>

ログストリームの ID

isPriority · boolean

優先ログストリームの場合は true、非優先の場合は false

name · string

ログストリーム名

pii_config · object

Show child attributes

sink · object

Show child attributes

status · enum<string>

ログストリームの status。指定可能な値: active、paused、suspended

利用可能なオプション: active, paused, suspended

type · enum<string>

利用可能なオプション: http