检查为 IBM Cloudant 实例配置了哪些事件类型

/_api/v2/user/activity_tracker/events 端点会在响应中返回一个 types 字段，该字段包含一个事件类型数组，该数组将针对 IBM Cloudant 实例发送到 IBM Cloud Activity Tracker Event Routing。

请参见以下示例请求，了解如何使用 HTTP 检索已配置事件类型的信息：

GET $SERVICE_URL/_api/v2/user/activity_tracker/events

在运行 curl 请求之前，请从命令行运行以下命令以获取 JWT 令牌: ibmcloud iam oauth-tokens | awk '{print $4}'

请参阅以下示例请求以检索有关事件类型的信息:

curl -H "Authorization: Bearer $JWT" -X GET "$SERVICE_URL/_api/v2/user/activity_tracker/events"

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.ActivityTrackerEvents;

Cloudant service = Cloudant.newInstance();

ActivityTrackerEvents response =
    service.getActivityTrackerEvents().execute().getResult();

System.out.println(response)

const { CloudantV1 } = require('@ibm-cloud/cloudant');

const service = CloudantV1.newInstance({});

service.getActivityTrackerEvents().then(response => {
  console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance()

response = service.get_activity_tracker_events().get_result()

print(response)

getActivityTrackerEventsOptions := service.NewGetActivityTrackerEventsOptions()

activityTrackerEvents, response, err := service.GetActivityTrackerEvents(getActivityTrackerEventsOptions)
if err != nil {
  panic(err)
}

b, _ := json.MarshalIndent(activityTrackerEvents, "", "  ")
fmt.Println(string(b))

先前的 Go 示例需要以下导入块:

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

所有 Go 示例都需要初始化 service 对象。 有关更多信息，请参阅 API 文档的 认证部分 以获取示例。

当您检查启用了哪些事件时，您将获得下列其中一个响应。

• 发送管理和数据事件类型时的响应:

{"types": ["management", "data"]}

• 仅发送管理事件时的响应:

{"types": ["management"]}

为 IBM Cloudant 实例配置数据事件

您可以通过将 POST 发送到 /_api/v2/user/activity_tracker/events 端点并通过 types 字段传递 JSON 对象来配置数据事件。

请参阅以下示例，了解如何使用 HTTP 配置事件类型：

POST $SERVICE_URL/_api/v2/user/activity_tracker/events

请参阅以下示例请求以配置事件类型:

curl -H "Authorization: Bearer $JWT" -X POST "$SERVICE_URL/_api/v2/user/activity_tracker/events" --data '{"types": ["management", "data"]}'

import java.util.Arrays;

import com.ibm.cloud.cloudant.v1.Cloudant;
import com.ibm.cloud.cloudant.v1.model.Ok;
import com.ibm.cloud.cloudant.v1.model.PostActivityTrackerEventsOptions;

Cloudant service = Cloudant.newInstance();

PostActivityTrackerEventsOptions options =
    new PostActivityTrackerEventsOptions.Builder()
        .types(Arrays.asList("management", "data"))
        .build();

Ok response =
    service.postActivityTrackerEvents(options).execute().getResult();

System.out.println(response);

const { CloudantV1 } = require('@ibm-cloud/cloudant');

const service = CloudantV1.newInstance({});

service.postActivityTrackerEvents({
  types: ['management', 'data'],
}).then(response => {
  console.log(response.result);
});

from ibmcloudant.cloudant_v1 import CloudantV1

service = CloudantV1.new_instance()

response = service.post_activity_tracker_events(
  types=['management', 'data']
).get_result()

print(response)

postActivityTrackerEventsOptions := service.NewPostActivityTrackerEventsOptions(
  []string{"management", "data"},
)

activityTrackerEvents, response, err := service.PostActivityTrackerEvents(postActivityTrackerEventsOptions)
if err != nil {
  panic(err)
}

b, _ := json.MarshalIndent(activityTrackerEvents, "", "  ")
fmt.Println(string(b))

先前的 Go 示例需要以下导入块:

import (
   "encoding/json"
   "fmt"
   "github.com/IBM/cloudant-go-sdk/cloudantv1"
)

所有 Go 示例都需要初始化 service 对象。 有关更多信息，请参阅 API 文档的 认证部分 以获取示例。

以下示例响应显示已接受更新:

{
  "ok":true
}

如果 types 字段包含无效事件类型，那么将返回类似于以下内容的响应:

{
  "code":400,
  "error":"Unknown event types: <unrecognized events>"
}

如果缺少 types 字段，那么将返回与以下字段相似的响应:

{
  "code":400,
  "error":"Missing required events: \"management\""
}

在 IBM Cloud Activity Tracker Event Routing 中看到的事件中反映出更改最长需要 5 分钟。