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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/log-streams/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "type": "category"
    }
  ],
  "isPriority": true,
  "name": "<string>",
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/log-streams/{id}"

payload = {
    "filters": [{ "type": "category" }],
    "isPriority": True,
    "name": "<string>",
    "sink": {
        "httpEndpoint": "<string>",
        "httpAuthorization": "<string>",
        "httpContentType": "<string>",
        "httpCustomHeaders": [
            {
                "header": "<string>",
                "value": "<string>"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/log-streams/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        [
                'type' => 'category'
        ]
    ],
    'isPriority' => true,
    'name' => '<string>',
    'sink' => [
        'httpEndpoint' => '<string>',
        'httpAuthorization' => '<string>',
        'httpContentType' => '<string>',
        'httpCustomHeaders' => [
                [
                                'header' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/log-streams/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"type\": \"category\"\n    }\n  ],\n  \"isPriority\": true,\n  \"name\": \"<string>\",\n  \"sink\": {\n    \"httpEndpoint\": \"<string>\",\n    \"httpAuthorization\": \"<string>\",\n    \"httpContentType\": \"<string>\",\n    \"httpCustomHeaders\": [\n      {\n        \"header\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/log-streams/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"type\": \"category\"\n    }\n  ],\n  \"isPriority\": true,\n  \"name\": \"<string>\",\n  \"sink\": {\n    \"httpEndpoint\": \"<string>\",\n    \"httpAuthorization\": \"<string>\",\n    \"httpContentType\": \"<string>\",\n    \"httpCustomHeaders\": [\n      {\n        \"header\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

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

承認

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