CLI 전제조건

CLI를 사용하여 경로를 관리하기 전에, 로컬 시스템에 최신 Activity Tracker Event Routing CLI V2 플러그인을 설치하십시오. Activity Tracker Event Routing CLI 설치를 참조하십시오.

그리고 IBM Cloud에 로그인하십시오. ibmcloud login 명령을 실행하십시오.

CLI를 사용하여 라우트 작성

Activity Tracker Event Routing 대상의 새 라우트를 작성하려면 이 명령을 사용하십시오.

ibmcloud atracker route create --name ROUTE_NAME  ( --target-ids TARGETS  [--locations REGIONS] | --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 0
Rules:                   [locations: [us-south], target_ids: [33333333-3333-3333-3333-333333333333]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:10:09.996Z

CLI를 사용하여 라우트 업데이트

Activity Tracker Event Routing 대상에 대한 라우트를 업데이트하려면 이 명령을 사용하십시오. 라우트가 원래 작성되었던 때와는 다르게 지정된 값이 명령에 지정된 값으로 업데이트됩니다.

ibmcloud atracker route update --route ROUTE [--name ROUTE_NAME] [--force] ( [--target-ids TARGETS]  [--locations REGIONS] | [--rules RULES] | [--file RULES_DEFINITION_JSON_FILE] ) [--output FORMAT] [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 1
Rules:                   [locations: [*], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:13:37.218Z

CLI를 사용하여 라우트 삭제

Activity Tracker Event Routing 라우트를 삭제하려면 이 명령을 사용하십시오.

ibmcloud atracker route rm --route ROUTE [--force]

Are you sure you want to remove the route with the Route ID 44444444-4444-4444-4444-444444444444? [y/N]> y
OK
Route with route ID 44444444-4444-4444-4444-444444444444 was successfully removed.

FAILED
No route found with route name - 33333333-3333-3333-3333-333333333333

CLI를 사용하여 라우트 보기

Activity Tracker Event Routing 라우트에 대한 정보를 가져오려면 이 명령을 사용하십시오.

ibmcloud atracker route get --route ROUTE [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route-0
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 2
Rules:                   [locations: [us-south], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:15:07.281Z

CLI를 사용하여 모든 라우트 나열

Activity Tracker Event Routing에 대해 구성된 모든 라우트를 나열하려면 이 명령을 사용하십시오.

ibmcloud atracker route ls [--output FORMAT]

Name                      ID                                     Rules                                              Route Version   API version   CreatedAt                  UpdatedAt
my-global-route           aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   [[11111111-1111-1111-1111-111111111111],[global]]  5               2             2022-05-04T20:18:00.595Z   2022-05-05T19:04:58.374Z
send-all-to-us-east       bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb   [[22222222-2222-2222-2222-222222222222],[*]]       0               2             2022-05-06T12:02:47.832Z   2022-05-06T12:02:47.832Z

API 라우트 및 조치

다음 표에는 라우트를 관리하는 데 실행할 수 있는 조치가 나열되어 있습니다.

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

• https://private.REGION.atracker.cloud.ibm.com 형식의 API 엔드포인트를 사용하여 사설 네트워크에서 라우트를 관리할 수 있습니다.

• https://REGION.atracker.cloud.ibm.com 형식의 API 엔드포인트를 사용하여 공용 네트워크에서 라우트를 관리할 수 있습니다.

• 라우트가 글로벌 구성이므로, 임의의 지역 엔드포인트를 사용하여 계정의 라우트를 관리할 수 있습니다.

• 계정 설정을 업데이트하여 공용 엔드포인트를 사용 안함으로 설정할 수 있습니다. 자세한 정보는 대상 및 지역 설정 구성을 참조하십시오.

REST API에 대한 자세한 정보는 라우트를 참조하십시오.

API 전제조건

라우트를 관리하기 위해 API 호출을 수행하려면 다음 단계를 완료하십시오.

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

API를 사용하여 라우트 작성

라우트를 작성하기 전에 대상을 작성해야 합니다.

다음과 같은 cURL 명령을 사용하여 라우트를 작성할 수 있습니다.

curl -X POST  <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

여기서,

• <ENDPOINT>는 라우트를 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.

• ROUTE_NAME은 라우트의 이름입니다. 이름의 최대 길이는 180자이며 -, ., _, :의 특수 문자를 포함할 수 없습니다.

  자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.

• LOCATIONS은(는) 라우트와 연관된 위치의 목록입니다. 글로벌 이벤트를 포함하려면 global을(를) 지정하십시오. 모든 위치를 포함하려면 *을(를) 지정하십시오. * 위치의 규칙과 함께 여러 규칙이 있는 경우, 다른 규칙은 * 위치의 규칙에서 지정한 대상으로 나머지 이벤트를 라우팅하는 다른 규칙과 일치하지 않는 이벤트의 지정된 대상으로 이벤트를 라우팅합니다.

• TARGET_ID은(는) 감사 이벤트가 라우팅 및 수집되는 위치를 정의하는 대상의 GUID입니다. 이는 다른 지역에 있는 대상의 GUID를 포함할 수 있습니다. TARGET_ID이(가) 비어 있으면 규칙과 일치하는 모든 이벤트가 버려집니다.

예를 들어, 다음의 cURL 요청을 사용하여 글로벌 및 미국 남부 위치 기반 이벤트가 계정에서 수집 및 라우팅되는 방법을 정의하는 라우트를 작성할 수 있습니다.

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global"],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

응답에서 라우트의 GUID를 나타내는 id와 라우트의 CRN을 표시하는 crn과 같은 라우트에 대한 정보를 얻습니다.

API를 사용하여 라우트 업데이트

라우트를 업데이트하는 경우 요청의 데이터 섹션에 라우트 정보를 포함해야 합니다.

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

다음과 같은 cURL 명령을 사용하여 라우트를 업데이트할 수 있습니다.

curl -X PUT  <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

여기서,

• <ENDPOINT>는 라우트를 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.

• <ROUTE_ID>은(는) 업데이트할 라우트의 ID입니다.

• ROUTE_NAME은 라우트의 이름입니다. 이름의 최대 길이는 180자이며 -, ., _, :의 특수 문자를 포함할 수 없습니다.

  자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.

• LOCATIONS은(는) 라우트와 연관된 위치의 목록입니다. 글로벌 이벤트를 포함하려면 global을(를) 지정하십시오. 모든 위치를 포함하려면 *을(를) 지정하십시오. * 위치의 규칙과 함께 여러 규칙이 있는 경우, 다른 규칙은 * 위치의 규칙에서 지정한 대상으로 나머지 이벤트를 라우팅하는 다른 규칙과 일치하지 않는 이벤트의 지정된 대상으로 이벤트를 라우팅합니다.

• TARGET_ID은(는) 감사 이벤트가 라우팅 및 수집되는 위치를 정의하는 대상의 GUID입니다. 이는 다른 지역에 있는 대상의 GUID를 포함할 수 있습니다. TARGET_ID이(가) 비어 있으면 규칙과 일치하는 모든 이벤트가 버려집니다.

예를 들어, 다음의 cURL 요청을 사용하여 글로벌 및 미국 남부 및 미국 동부 위치 기반 이벤트가 계정에서 수집 및 라우팅되는 방법을 정의하는 라우트를 업데이트할 수 있습니다.

curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global", "us-east],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

API를 사용하여 라우트 삭제

다음과 같은 cURL 명령을 사용하여 라우트를 삭제할 수 있습니다.

curl -X DELETE   <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

여기서,

• <ENDPOINT>는 라우트를 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.
• <ROUTE_ID>은(는) 삭제할 라우트의 ID입니다.

예를 들어, 다음의 cURL 요청을 실행하여 ID가 aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa인 라우트를 삭제할 수 있습니다.

curl -X DELETE  https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

API를 사용하여 라우트 보기

다음과 같은 cURL 명령을 사용하여 1개의 라우트를 볼 수 있습니다.

curl -X GET   <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

여기서,

• <ENDPOINT>는 라우트를 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.
• <ROUTE_ID>은(는) 페치할 라우트의 ID입니다.

예를 들어, 다음의 cURL 요청을 실행하여 ID가 aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa인 라우트에 대한 정보를 얻을 수 있습니다.

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

API를 사용하여 지역의 모든 라우트 나열

다음과 같은 cURL 명령을 사용하여 모든 라우트를 볼 수 있습니다.

curl -X GET   <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

여기서,

• <ENDPOINT>는 라우트를 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.

예를 들어, 다음의 cURL 요청을 실행하여 미국 남부에서 정의된 라우트에 대한 정보를 얻을 수 있습니다.

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

HTTP 응답 코드

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

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

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

UI를 사용하여 라우트 작성

1. IBM Cloud 계정에 로그인하십시오.
2. 메뉴 아이콘을 클릭하세요. > 가시성.
3. '활동 추적'을 선택하세요.
4. 라우트를 선택하십시오.
5. ‘생성’을 클릭하여 생성 페이지를 엽니다.
6. 경로에 의미 있는 이름을 입력하세요.
7. 라우팅 규칙에서 규칙 1 을 수정하십시오.
   • 다음에서 감사 이벤트 전송: 이 규칙과 일치하는 감사 이벤트 위치를 선택하십시오.
   • 대상: 이 규칙에 첨부될 대상을 선택하십시오. 규칙에 더 많은 대상을 추가하려면 대상 추가 를 클릭하십시오.
8. 라우트에 추가 규칙을 추가하려면 규칙 추가 를 클릭하십시오.
   • 라우트 규칙의 순서는 라우팅 동작에 영향을 줍니다. 규칙은 순서대로 처리되며 규칙이 일치하면 후속 규칙이 처리되지 않습니다.
9. 각 규칙에는 규칙 순서를 변경할 수 있는 위로 및 아래로 화살표가 있습니다.
10. 각 규칙에는 라우트에서 규칙을 삭제할 수 있는 제거 단추가 있습니다.
11. 라우트 정의를 검토하여 규칙의 순서가 의도한 대로인지 확인하십시오.
12. 작성을 클릭하십시오.

UI를 사용하여 경로 업데이트하기

1. IBM Cloud 계정에 로그인하십시오.
2. 메뉴 아이콘을 클릭하세요. > 가시성.
3. '활동 추적'을 선택하세요.
4. 라우트를 선택하십시오.
5. 업데이트할 라우트를 판별하고 를 클릭하십시오.
6. 라우트의 이름을 바꾸려면 이름 바꾸기 를 클릭하십시오.
7. 편집 을 클릭하여 라우트 규칙을 업데이트하십시오.
8. 원하는 경우 기존 규칙을 편집하십시오.
   • 다음에서 감사 이벤트 전송: 이 규칙과 일치하는 감사 이벤트 위치를 선택하십시오.
   • 대상: 이 규칙에 첨부될 대상을 선택하십시오. 규칙에 더 많은 대상을 추가하려면 대상 추가 를 클릭하십시오.
9. 라우트에 추가 규칙을 추가하려면 규칙 추가 를 클릭하십시오.
   • 라우트 규칙의 순서는 라우팅 동작에 영향을 줍니다. 규칙은 순서대로 처리되며 규칙이 일치하면 후속 규칙이 처리되지 않습니다.
10. 각 규칙에는 규칙 순서를 변경할 수 있는 위로 및 아래로 화살표가 있습니다.
11. 각 규칙에는 라우트에서 규칙을 삭제할 수 있는 제거 단추가 있습니다.
12. 업데이트 를 클릭하여 라우트를 변경하십시오.

UI를 사용하여 경로 보기

1. IBM Cloud 계정에 로그인하십시오.
2. 메뉴 아이콘을 클릭하세요. > 가시성.
3. '활동 추적'을 선택하세요.
4. 라우트를 선택하십시오.
5. 라우트 테이블은 작성 날짜별로 정렬됩니다. 라우트의 순서는 라우팅 동작에 영향을 주지 않습니다.
6. 각 라우트 블록은 라우트 이름 및 규칙을 표시합니다.
7. 라우트 페이지에는 라우팅 구성에 대한 추가 정보와 함께 라우팅 지침 도 표시됩니다.

UI를 사용하여 라우트 삭제

1. IBM Cloud 계정에 로그인하십시오.
2. 메뉴 아이콘을 클릭하세요. > 가시성.
3. '활동 추적'을 선택하세요.
4. 라우트를 선택하십시오.
5. 업데이트할 라우트를 판별하고 를 클릭하십시오.
6. 전체 라우트를 삭제하려면 삭제 를 클릭하십시오. 라우트를 삭제하기 전에 라우트 이름을 입력해야 합니다.