CLI 전제조건

CLI를 사용하여 Activity Tracker Event Routing 계정 설정을 관리하기 전에 IBM Cloud Activity Tracker Event Routing CLI를 설치 하십시오.

Activity Tracker Event Routing 계정 설정을 읽거나 업데이트할 수 있는 IAM 권한이 있는지 확인합니다.

CLI를 사용한 계정 설정

이 명령을 사용하여 IBM Cloud Activity Tracker Event Routing 계정 구성에 대한 설정을 가져올 수 있습니다.

ibmcloud atracker setting get [--output FORMAT]

Atracker settings
Metadata region primary:     us-south
Metadata region backup:      us-east
Default targets:             []
Permitted target regions:    []
Private api endpoint only:   false
API version:                 2

CLI를 사용한 설정 업데이트

기본 대상, 허용된 대상 지역 및 기본 메타데이터 지역 등 현재 계정 설정을 수정하려면 이 명령을 사용하십시오.

ibmcloud atracker setting update [--metadata-region-primary REGION] [--metadata-region-backup REGION] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--private-api-endpoint-only ( TRUE | FALSE )] [--output FORMAT] [--force]

API 설정 및 조치

다음의 표에는 설정을 관리하기 위해 실행할 수 있는 조치가 나열되어 있습니다.

개인용 및 공용 엔드포인트를 사용하여 설정을 관리할 수 있습니다. 사용 가능한 ENDPOINTS 목록에 대한 자세한 정보는 엔드포인트를 참조하십시오.

• 기본적으로는 사설 네트워크에서 설정을 관리할 수 있습니다. https://private.<region>.atracker.cloud.ibm.com 형식으로 된 API 엔드포인트를 사용해야 합니다.

• 또한 지역에서 공용 엔드포인트를 사용하여 설정을 관리할 수도 있습니다. 자세한 정보는 엔드포인트 관리를 참조하십시오.

REST API에 대한 자세한 내용은 설정 API를 참조하세요.

API 전제조건

설정을 관리하는 API 호출을 작성하려면 다음의 단계를 완료하십시오.

1. IAM 액세스 토큰을 가져오십시오. 자세한 정보는 IAM 액세스 토큰 검색을 참조하십시오.
2. 설정을 구성 또는 관리하려는 지역에서 API 엔드포인트를 식별하십시오. 자세한 정보는 엔드포인트를 참조하십시오.

API를 사용한 설정 가져오기

다음의 cURL 명령을 사용하여 기존의 설정 정보를 가져올 수 있습니다.

curl -X GET  ENDPOINT/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

여기서:

ENDPOINT

대상을 구성 또는 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.

예를 들어, 다음의 cURL 요청 설정 정보를 미국 남부 지역에서 사용할 수 있습니다.

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

다음과 유사한 응답이 리턴됩니다.

{
 "default_targets": ["50375218-0000-4234-bbb4-171bebab8408", "c7519d8a-5f97-498b-0000-8542f60955cd"],
 "permitted_target_regions": ["us-south", "us-east"],
 "metadata_region_primary": "us-south",
 "metadata_region_backup": "eu-de",
 "private_api_endpoint_only": false
}

여기서:

default_targets

대상 ID의 목록입니다. 다른 대상으로 이벤트가 전송되도록 하는 라우팅 규칙이 없는 경우, 해당 대상이 이벤트를 수신합니다.

permitted_target_regions

대상을 정의하는 데 사용할 수 있는 지역의 목록입니다. 허용된 최대 두 개의 대상 지역이 허용됩니다.

metadata_region_primary

라우트 및 대상 정의와 연관된 메타데이터가 저장되는 지역입니다.

metadata_region_backup

경로 및 대상 정의와 관련된 메타데이터가 백업 위치로 저장되는 영역입니다.

private_api_endpoint_only

개인용 엔드포인트를 사용할 수 있는지 여부를 지정합니다. true인 경우 개인 엔드포인트만 사용할 수 있습니다.

API를 사용한 설정 업데이트

설정을 업데이트할 때는 요청의 데이터 섹션에 설정 정보를 포함해야 합니다.

• 모든 필드를 전달해야 합니다.
• 변경이 필요한 필드를 업데이트하십시오.

다음의 cURL 명령을 사용하여 설정을 업데이트할 수 있습니다.

curl -X PUT  <ENDPOINT>/api/v2/settings
-H "Authorization:  $ACCESS_TOKEN"
-H "content-type: application/json"
-d '{
   "default_targets": ["IDs"],
   "permitted_target_regions": ["REGIONS"],
   "metadata_region_primary": "REGION",
   "metadata_region_backup": "REGION",
   "private_api_endpoint_only": false
}'

여기서:

ENDPOINT

대상을 구성 또는 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.

default_targets

대상 ID의 목록입니다. 다른 대상으로 이벤트가 전송되도록 하는 라우팅 규칙이 없는 경우, 해당 대상이 이벤트를 수신합니다.

permitted_target_regions

대상을 정의하는 데 사용할 수 있는 지역의 목록입니다. 최대 두 개까지 허용된 대상 지역을 지정할 수 있습니다.

metadata_region_primary

라우트 및 대상 정의와 연관된 메타데이터가 저장되는 지역입니다.

metadata_region_backup

경로 및 대상 정의와 관련된 메타데이터가 백업 위치로 저장되는 영역입니다.

private_api_endpoint_only

개인용 엔드포인트를 사용할 수 있는지 여부를 지정합니다. true인 경우 개인 엔드포인트만 사용할 수 있습니다.

HTTP 응답 코드

IBM Cloud Activity Tracker Event Routing REST API를 사용하는 경우 표준 HTTP 응답 코드를 가져와서 메소드가 완료되었는지 여부를 표시할 수 있습니다.

• 200 응답은 항상 성공을 나타냅니다.
• 4xx 응답은 실패를 나타냅니다.
• 5xx 응답은 일반적으로 내부 시스템 오류를 나타냅니다.

일부 HTTP 응답 코드는 다음 표를 참조하십시오.

UI를 사용하여 계정 설정하기

1. IBM Cloud 계정에 로그인하십시오.
2. 메뉴 아이콘 > 관측성을 클릭하십시오.
3. Activity Tracker를 선택하십시오.
4. 라우팅을 선택하십시오.
5. 설정을 선택하십시오.

이 페이지에서 다음 설정을 볼 수 있습니다.

• 메타데이터 위치: 기본 메타데이터 영역 및 백업 메타데이터 영역을 표시합니다.
• 허용된 대상 지역. 이벤트를 보낼 수 있는 대상 리젼을 표시합니다.
• 기본 대상: 구성된 기본 대상을 표시합니다.
• 공용 엔드포인트: 공용 엔드포인트가 사용되는지 여부를 표시합니다. 사용 안함으로 설정하면 Activity Tracker Event Routing UI에 액세스할 수 없습니다.
• 보고서: JSON 형식으로 구성을 표시합니다.

UI를 사용하여 설정 업데이트하기

1. IBM Cloud 계정에 로그인하십시오.
2. 메뉴 아이콘 > 관측성을 클릭하십시오.
3. Activity Tracker를 선택하십시오.
4. 라우팅을 선택하십시오.
5. 설정을 선택하십시오.

변경할 설정 옆에 있는 편집 을 클릭하십시오. 다음 설정을 수정할 수 있습니다:

• 메타데이터 위치: 원하는 기본 메타데이터 영역 및 백업 메타데이터 영역을 선택하십시오.
• 허용된 대상 리젼: 대상을 작성할 수 있는 리젼을 선택하십시오. 지역을 선택하지 않으면 모든 지역이 이벤트를 수신할 수 있습니다.
• 기본 대상: 라우팅 규칙이 존재하지 않거나 일치하지 않을 때 기본적으로 사용할 대상을 선택하십시오.