Event Streams 대상 관리
IBM Cloud Activity Tracker Event Routing CLI, IBM Cloud Activity Tracker Event Routing REST API 및 Terraform 스크립트를 사용하여 계정 내의 IBM® Event Streams for IBM Cloud® ( Event Streams ) 타깃을 관리할 수 있습니다. 대상은 감사 이벤트를 수집할 수 있는 리소스입니다.
IBM Cloud Activity Tracker Event Routing 대상에 대한 자세한 내용은 대상을 참조하세요.
IAM 액세스
대상을 관리하려면 사용자에게 IAM 권한을 부여해야 합니다. 자세한 내용은 리소스에 대한 액세스 할당을 참조하세요.
정책을 정의할 때 권한 범위를 지정할 수 있습니다. 특정 지역이나 전체 계정에 대한 권한을 부여하도록 선택할 수 있습니다.
정책 및 권한 부여를 생성할 수 있는 IAM 권한이 있는 경우 대상 서비스의 사용자로서 갖는 액세스 수준만 부여할 수 있습니다. 예를 들어, 대상 서비스에 대한 ‘조회자’ 권한이 있는 경우, 권한 부여 시 ‘조회자’ 역할만 할당할 수 있습니다. 관리자와 같은 더 높은 권한을 할당하려고 하면 권한이 부여된 것처럼 보일 수 있지만, 실제로는 대상 서비스에 대해 사용자가 가진 가장 높은 수준의 권한, 즉 뷰어 권한만 할당됩니다.
지역별 접근 권한을 가진 사용자는 승인된 지역 내 대상에만 접근할 수 있습니다.
| IAM 조치 | IAM 정책 범위 | IAM 역할 | 설명 |
|---|---|---|---|
atracker.target.read |
지역 | AdministratorEditorViewerOperator |
대상에 대한 정보 읽기(보기) |
atracker.target.create |
지역 | AdministratorEditor |
대상 작성 |
atracker.target.update |
지역 | AdministratorEditor |
대상 업데이트 |
atracker.target.delete |
지역 | AdministratorEditor |
대상 삭제 |
atracker.target.list |
계정 | AdministratorEditorViewerOperator |
모든 대상 나열 |
Event Streams에 대한 IAM 액세스
단일 Event Streams 주제에 대한 액세스를 제한해야 하는 경우 두 가지 정책을 만들어야 합니다.
- 주제에 대한 작성자 역할의 정책과 주제의 이름을 가진
resource ID입니다. - 리더 역할이 있는 클러스터에 대한 정책입니다.
인증 옵션
Event Streams 대상에 쓸 때 다음 옵션 중 하나를 사용하여 IBM® Event Streams for IBM Cloud® 주제에 대해 인증할 수 있습니다.
- 서비스 간( S2S ) 인증을 구성하여(권장).
- 대상의 구성 시에 API 키를 제공하여.
서비스 간 권한 부여를 {{site.data.keyword. messagehub}} 항목에 데이터를 쓸 때 API 키 를 전달할 필요가 없도록 Event Streams 항목에 대한 서비스-투-서비스 인증이 이루어지도록 하세요.
CLI 전제조건
CLI를 사용하여 대상을 관리하기 전에 다음 단계를 완료하십시오.
-
IBM Cloud CLI를 설치하십시오.
-
IBM Cloud Activity Tracker Event Routing CLI를 설치하십시오.
Event Streams CLI 명령을 실행하려면
atrackerCLI 0.3.2 ) 버전 이상이 필요합니다. 이전에atrackerCLI를 설치했다면ibmcloud plugin update atracker실행하여atrackerCLI 플러그인을 업그레이드해야 할 수도 있습니다. -
IBM Cloud에 로그인하십시오. ibmcloud login 명령을 실행하십시오.
Event Streams 인스턴스 API 키 얻기
Event Streams 인스턴스 API 키를 얻는 방법에 대한 자세한 내용은 주제에 액세스하기 위한 API 키 생성을 참조하세요.
동일한 계정 내에서 UI를 사용하여 S2S 인증 구성하기
IBM Cloud UI를 사용하여 서비스 대 서비스 권한을 구성하려면 다음을 수행하십시오.
-
IBM Cloud Activity Tracker Event Routing 대상을 구성할 계정 소유자로 IBM Cloud 계정에 로그인하십시오.
사용자 ID와 비밀번호로 로그인하면 IBM Cloud 대시보드가 열립니다.
-
‘관리’를 클릭하세요 > 액세스(IAM). ‘접근 및 사용자 관리 ’ 화면이 표시됩니다.
-
권한을 클릭하십시오.
-
작성을 클릭하십시오.
-
소스 서비스 에서 다음을 선택하세요 Activity Tracker 그리고 '접근 범위를 어떻게 설정하시겠습니까? '에서 '모든 리소스'를 선택하십시오.
-
대상 서비스 에서 다음을 선택하십시오. Message Hub**'액세스 범위를 어떻게 설정하시겠습니까?** ' 항목에서 '선택한 속성을 기반으로 리소스'를 선택하십시오.
-
서비스 인스턴스 를 선택하고, 문자열이 같음 에 Event Streams 인스턴스의 이름을 입력하세요.
-
서비스 액세스를 위해 ‘Writer’를 선택하십시오.
-
권한 부여를 클릭하십시오. 새 서비스 대 서비스 권한이 인증 관리 보기에 나열됩니다.
CLI를 사용하여 S2S 인증 구성하기
IBM Cloud CLI를 사용하여 서비스 대 서비스 권한을 구성하려면 다음을 수행하십시오.
-
IBM Cloud 계정에 로그인하세요 IBM Cloud Activity Tracker Event Routing 인증을 설정할 계정 소유자로서.
-
서비스 대 서비스 권한을 정의하는 권한 정책을 작성하십시오.
ibmcloud iam authorization-policy-create atracker messagehub "Writer" [--target-service-instance-id <IES_SERVICE_INSTANCE>여기서:
IES_SERVICE_INSTANCE인증을 받을 Event Streams 인스턴스의 CRN입니다.
API를 사용하여 S2S 인증 구성하기
IBM Cloud API를 사용하여 서비스 대 서비스 권한을 구성하려면 다음을 수행하십시오.
-
IBM Cloud Activity Tracker Event Routing IAM 권한을 구성할 계정 소유자로 IBM Cloud 계정에 로그인하십시오.
-
서비스 대 서비스 권한을 정의하는
authorization_policy_resource.json파일을 작성하십시오.{ "type": "authorization", "subjects": [ { "attributes": [ { "name": "accountId", "value": "CUSTOMER_ACCOUNT_ID" }, { "name": "serviceName", "value": "atracker" } ] } ], "roles": [ { "role_id": "crn:v1:bluemix:public:iam::::serviceRole:Writer" } ], "resources": [ { "attributes": [ { "name": "accountId", "value": "CUSTOMER_ACCOUNT_ID" }, { "name": "serviceName", "value": "messagehub" }, { "name": "serviceInstance", "value": "IES_SERVICE_INSTANCE" } ] } ] }여기서:
CUSTOMER_ACCOUNT_ID은(는) 대상을 구성할 계정의 계정 GUID입니다.ibmcloud account list명령을 사용하여 이를 찾을 수 있습니다.IES_SERVICE_INSTANCE인증될 IES 인스턴스의 CRN입니다. -
IAM 액세스 토큰을 가져오십시오. 자세한 정보는 IAM 액세스 토큰 검색을 참조하십시오.
-
다음의 명령을 실행하여 서비스 대 서비스 권한을 구성하십시오.
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: $ACCESS_TOKEN" -d @authorization_policy_resource.json "https://iam.cloud.ibm.com/v1/policies"
CLI를 사용하여 Event Streams 대상 만들기
이 명령어를 사용하여 활동 이벤트의 전송 대상을 구성하는 데 사용할 ‘ IBM® Event Streams for IBM Cloud® ’ 타깃을 생성하십시오.
ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn EVENTSTREAMS_TARGET_CRN] [--brokers BROKER_LIST] [--topic TOPIC] [--api-key ( EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]) ) [--region REGION] [--output FORMAT]
명령 옵션
--region REGION|-r REGION-
지역의 이름입니다(예:
us-south또는eu-gb). 지정되지 않은 경우 로그인하거나 대상으로 지정된 지역이 사용됩니다. --name TARGET_NAME-
대상에 지정되는 이름입니다.
자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.
--type TARGET_TYPE-
Event Streams 대상에 대해
TARGET_TYPEevent_streams로 설정합니다. --file @EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE-
다음 형식의 엔드포인트 정의를 포함하는 파일입니다.
{ "target_crn": "yyyyy", "brokers": ["broker-1:9093","broker-2:9093"], "topic": "my-topic", "api_key": "xxxxxxxxxxxxxx" } --target-crn이벤트 스트림 대상 CRN-
IBM® Event Streams for IBM Cloud® 인스턴스의 CRN입니다. 서비스 자격 증명에서 소스 CRN을 가져올 수 있습니다.
--brokers BROKER_LIST-
Event Streams 브로커(엔드포인트) 목록입니다. 이는 서비스 자격 증명의
kafka_brokers_sasl값입니다. --topic TOPIC-
Event Streams 이벤트가 전송되는 대상의 주제 이름. 이는 Event Streams 인스턴스에 대해 생성된 주제의 이름입니다.
--api-key EVENTSTREAMS_API_KEY|@EVENTSTREAMS_API_KEY_FILE-
Event Streams 서비스 자격 증명에서 비밀번호 값을 찾았습니다. 이것은 IAM API 키입니다.
--service-to-service-enabled-
IBM Cloud Activity Tracker Event Routing 에 서비스 간 인증이 활성화되어 있는지 확인합니다. 서비스 간 연결이 활성화되어 있고 APIKey를 제공하지 않는 경우 이 플래그를 true로 설정합니다.
--output FORMAT-
현재 지원되는 형식은 JSON입니다. 지정된 경우 출력은 JSON 형식으로 리턴됩니다.
JSON이 지정되지 않은 경우 출력이 테이블 형식으로 리턴됩니다. help|--help|-h-
명령에 사용할 수 있는 옵션을 나열합니다.
예
다음은 ibmcloud atracker target create --name new-target-name --type event-streams --target-crn "crn:v1:bluemix:public:messagehub:eu-de:a/11111111111111111111111111111111:22222222-2222-2222-2222-222222222222::" --brokers "broker-1:9093,broker-2:9093" --topic "topic-name" --api-key xxxxx 명령을 사용하는 예제입니다.
다음은 성공적인 대상 작성 예제입니다.
Target
Name: my-target
ID: 000000000-00000000-0000-0000-00000000
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region: us-south
Type: event_streams
Event Streams Target CRN: crn:v1:bluemix:public:messagehub:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic: my-topic
Event Streams Brokers: [broker-1:9093,broker-2:9093]
Write Status: success
CreatedAt: 2022-10-20T19:20:38.888Z
UpdatedAt: 2022-10-20T19:20:38.888Z
CLI를 사용하여 Event Streams 대상 업데이트
이 명령어를 사용하여 IBM Cloud Activity Tracker Event Routing 리전의 ‘ Event Streams ’ 타깃을 업데이트하십시오. 대상이 원래 작성되었던 때와는 다르게 지정된 값이 명령에 지정된 값으로 업데이트됩니다.
ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--brokers BROKER_LIST] [--target-crn EVENTSTREAMS_TARGET_CRN] [--topic TOPIC] ( [--api-key ( EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]
명령 옵션
--region REGION|-r REGION-
지역의 이름입니다(예:
us-south또는eu-gb). 지정되지 않은 경우 로그인하거나 대상으로 지정된 지역이 사용됩니다. --target TARGET-
ID 또는 현재 대상 이름입니다.
--name TARGET_NAME-
대상에 지정되는 이름입니다.
자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.
--file @EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE-
다음 형식의 엔드포인트 정의를 포함하는 파일입니다.
{ "endpoint": "aaaaa", "target_crn": "yyyyy", "bucket": "zzzzzz", "api_key": "xxxxxx" }또는 서비스 대 서비스 인증이 사용 가능한 시나리오의 경우:
{ "target_crn": "yyyyy", "brokers": ["broker-1:9093","broker-2:9093"], "topic": "my-topic", "api_key": "xxxxxxxxxxxxxx" } --target-crn이벤트 스트림 대상 CRN-
IBM® Event Streams for IBM Cloud® 인스턴스의 CRN입니다. 서비스 자격 증명에서 소스 CRN을 가져올 수 있습니다.
--brokers BROKER_LIST-
Event Streams 브로커(엔드포인트) 목록입니다. 이는 서비스 자격 증명의
kafka_brokers_sasl값입니다. --topic TOPIC-
Event Streams 이벤트가 전송되는 대상의 주제 이름. 이는 Event Streams 인스턴스에 대해 생성된 주제의 이름입니다.
--api-key EVENTSTREAMS_API_KEY|@EVENTSTREAMS_API_KEY_FILE-
Event Streams 서비스 자격 증명에서 비밀번호 값을 찾았습니다. 이것은 IAM API 키입니다
--service-to-service-enabled-
IBM Cloud Activity Tracker Event Routing 에 서비스 간 인증이 활성화되어 있는지 확인합니다. 서비스 간 연결이 활성화되어 있고 APIKey를 제공하지 않는 경우 이 플래그를 true로 설정합니다.
--output FORMAT-
현재 지원되는 형식은 JSON입니다. 지정된 경우 출력은 JSON 형식으로 리턴됩니다.
JSON이 지정되지 않은 경우 출력이 테이블 형식으로 리턴됩니다. help|--help|-h-
명령에 사용할 수 있는 옵션을 나열합니다.
예
다음은 ibmcloud atracker target update --target my-target --name new-target-name 명령을 사용하는 예제입니다.
Target
Name: my-new-target
ID: 000000000-00000000-0000-0000-00000000
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region: us-south
Type: event_streams
Event Streams Target CRN: crn:v1:bluemix:public:messagehub:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic: my-topic
Event Streams Brokers: [broker-1:9093,broker-2:9093]
Write Status: success
CreatedAt: 2022-10-20T19:20:38.888Z
UpdatedAt: 2022-10-20T19:20:38.888Z
CLI를 사용하여 대상 삭제
이 명령을 사용하여 대상을 삭제할 수 있습니다.
ibmcloud atracker target rm --target TARGET [--force]
명령 옵션
--target TARGET- 대상의 ID 또는 이름입니다.
--force|-f- 사용자에게 추가 프롬프트를 제공하지 않고 대상을 삭제합니다.
help|--help|-h- 명령에 사용할 수 있는 옵션을 나열합니다.
예
다음은 ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 명령을 사용하는 예제입니다.
Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.
다음은 ibmcloud atracker target rm --target xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -force 명령을 사용하는 예제입니다.
이 예는 지정된 대상을 찾을 수 없는 실패한 명령을 보여줍니다.
Are you sure you want to remove the Target bearing Target ID 33333333-3333-3333-3333-333333333333? [y/N]> y
FAILED
Something went wrong. Error:
Status Code: 404
Incident ID: 67a33257-d5a4-46ec-94d9-14eb70e94f3d
Code: not_found
Message: The target id specified in `target_id` field is not found.
CLI를 사용하여 대상 유효성 검증
이 명령을 사용하여 대상이 IBM Cloud Activity Tracker Event Routing 지역에 대해 올바르게 구성되었는지 유효성 검증하십시오.
ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]
명령 옵션
--target TARGET- 대상의 ID 또는 이름입니다.
--region REGION|-r REGION- 지역의 이름입니다(예:
us-south또는eu-gb). 지정되지 않은 경우 로그인하거나 대상으로 지정된 지역이 사용됩니다. --output FORMAT- 현재 지원되는 형식은 JSON입니다. 지정된 경우 출력은 JSON 형식으로 리턴됩니다.
JSON이 지정되지 않은 경우 출력이 테이블 형식으로 리턴됩니다. help|--help|-h- 명령에 사용할 수 있는 옵션을 나열합니다.
예
다음은 ibmcloud atracker target validate --target new-target-name 명령을 사용하는 예제입니다.
이 예제는 유효성 검증을 성공적으로 통과한 ‘ Event Streams ’ 타깃을 보여줍니다.
Target
Name: new-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region: us-south
Type: event_streams
Event Streams Target CRN: crn:v1:bluemix:public:messagehub:us-south:a/a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic: my-test-topic
Event Streams Brokers: [broker-1:9093,broker-2:9093]
Write Status: success
CreatedAt: 2022-10-20T19:20:38.888Z
UpdatedAt: 2022-10-20T19:20:38.888Z
CLI를 사용하여 대상에 대한 정보 얻기
이 명령을 사용하여 IBM Cloud Activity Tracker Event Routing 지역의 대상에 대한 정보를 얻으십시오.
ibmcloud atracker target get --target TARGET [--output FORMAT]
명령 옵션
--target TARGET- 대상의 ID 또는 이름입니다.
--output FORMAT- 현재 지원되는 형식은 JSON입니다. 지정된 경우 출력은 JSON 형식으로 리턴됩니다.
JSON이 지정되지 않은 경우 출력이 테이블 형식으로 리턴됩니다. help|--help|-h- 명령에 사용할 수 있는 옵션을 나열합니다.
예
다음은 **ibmcloud atracker target get --target new-target-name**Event Streams 타깃을 보여주는 명령어 사용 예시입니다.
Target
Name: updated-target-name
ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN: crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region: us-south
Type: event_streams
Event Streams Target CRN: crn:v1:bluemix:public:messagehub:us-south:a/a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic: my-test-topic
Event Streams Brokers: [broker-1:9093,broker-2:9093]
Write Status: success
CreatedAt: 2022-10-20T19:20:38.888Z
UpdatedAt: 2022-10-20T19:20:38.888Z
지역의 모든 대상 나열
이 명령을 사용하여 IBM Cloud Activity Tracker Event Routing 지역에 구성된 대상을 나열하십시오.
ibmcloud atracker target ls [--output FORMAT]
명령 옵션
--output FORMAT- 현재 지원되는 형식은 JSON입니다. 지정된 경우 출력은 JSON 형식으로 리턴됩니다.
JSON이 지정되지 않은 경우 출력이 테이블 형식으로 리턴됩니다. help|--help|-h- 명령에 사용할 수 있는 옵션을 나열합니다.
예
다음은 ibmcloud atracker target ls 명령을 사용하는 예제입니다.
Name ID Region Type Service to Service Enabled Created
target-01 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx us-south event_streams - 2020-11-18T03:52:08.603Z
target-02 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy us-south event_streams - 2020-11-18T03:52:01.592Z
target-02-backup zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz us-east event_streams - 2021-02-26T06:53:13.466Z
API 대상 및 조치
다음 표에는 대상을 관리하기 위해 실행할 수 있는 조치가 나열되어 있습니다.
| 조치 | REST API 메소드 | API_URL |
|---|---|---|
| 대상 작성 | POST |
<ENDPOINT>/api/v2/targets |
| 대상 업데이트 | PUT |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| 대상 삭제 | DELETE |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| 대상 읽기 | GET |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| 모든 대상 나열 | GET |
<ENDPOINT>/api/v2/targets |
| 대상 유효성 검증 | POST |
<ENDPOINT>/api/v2/targets/{id}/validate |
사설 및 공용 엔드포인트를 사용하여 대상을 관리할 수 있습니다. 사용 가능한 ENDPOINTS 목록에 대한 자세한 정보는 엔드포인트를 참조하십시오.
-
다음 형식의 API 엔드포인트를 사용하여 사설 네트워크에서 대상을 관리할 수 있습니다.
https://private.REGION.atracker.cloud.ibm.com -
다음 형식의 API 엔드포인트를 사용하여 공용 네트워크에서 대상을 관리할 수 있습니다.
https://REGION.atracker.cloud.ibm.com -
계정 설정을 업데이트하여 공용 엔드포인트를 사용 안함으로 설정할 수 있습니다. 자세한 정보는 대상 및 지역 설정 구성을 참조하십시오.
REST API에 대한 자세한 정보는 대상을 참조하십시오.
API 전제조건
대상을 관리하는 API 호출을 수행하려면 다음 단계를 완료하십시오.
- IAM 액세스 토큰을 가져오십시오. 자세한 정보는 IAM 액세스 토큰 검색을 참조하십시오.
- 대상을 구성하거나 관리할 지역에서 API 엔드포인트를 식별하십시오. 자세한 정보는 엔드포인트를 참조하십시오.
API를 사용하여 Event Streams 타겟 생성
다음 curl 명령어를 사용하여 IBM® Event Streams for IBM Cloud® ( Event Streams ) 타깃을 생성할 수 있습니다:
curl -X POST <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"target_type": "TARGET_TYPE",
"eventstreams_endpoint": {
"target_crn": "EVENTSTREAMS_CRN",
"brokers": "BROKER_LIST",
"topic”: "TOPIC_NAME",
"password": "API_KEY",
"service_to_service_enabled": false}
}
}'
여기서,
-
TARGET_NAME은 대상의 이름입니다. 이름의 최대 길이는 256자입니다.자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.
-
TARGET_TYPE은 대상의 유형입니다. Event Streams 대상에 대해 값을event_streams로 설정합니다. -
BROKER_LIST은 Event Streams 브로커(엔드포인트) 목록입니다. -
TOPIC_NAME이벤트가 전송되는 Event Streams 주제 이름의 이름입니다. -
API_KEY은 Event Streams 서비스 자격 증명에서 발견된 비밀번호 값입니다. 이것은 IAM API 키입니다. -
service_to_service_enabledIBM Cloud Activity Tracker Event Routing 에 서비스 간 인증이 활성화되어 있는지 확인합니다. 서비스 간 연결이 활성화되어 있고 APIKey를 제공하지 않는 경우 이 플래그를 true로 설정합니다.
응답에서 대상의 GUID를 표시하는 id, 대상의 CRN을 표시하는 crn과 같은 대상에 대한 정보를 얻습니다.
API를 사용하여 Event Streams 대상 업데이트
IBM® Event Streams for IBM Cloud® ( Event Streams ) 타깃을 업데이트할 때는 요청의 데이터 섹션에 해당 타깃 정보를 반드시 포함해야 합니다.
- 모든 필드를 전달해야 합니다.
- 변경해야 하는 필드를 업데이트하십시오.
- 일단 작성되면 대상의
target_type을(를) 변경할 수 없습니다.
다음과 같은 cURL 명령을 사용하여 대상을 업데이트할 수 있습니다.
curl -X PUT <ENDPOINT>/api/v2/targets/TARGET_ID -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json" -d '{
"name": "TARGET_NAME",
"target_type": "TARGET_TYPE",
"eventstreams_endpoint": {
"target_crn": "EVENTSTREAMS_CRN",
"brokers": "BROKER_LIST",
"topic”: "TOPIC_NAME",
"password": "API_KEY",
"service_to_service_enabled": false}
}
}'
여기서,
-
TARGET_ID는 대상의 ID입니다. -
TARGET_NAME은 대상의 이름입니다. 이름의 최대 길이는 256자입니다.자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.
-
TARGET_TYPE은 대상의 유형입니다. Event Streams 대상에 대해 값을event_streams로 설정합니다. -
BROKER_LIST은 Event Streams 브로커(엔드포인트) 목록입니다. -
TOPIC_NAME이벤트가 전송되는 Event Streams 주제의 이름입니다. -
API_KEY은 Event Streams 서비스 자격 증명에서 발견된 비밀번호 값입니다. 이것은 IAM API 키입니다. -
service_to_service_enabledIBM Cloud Activity Tracker Event Routing 에 서비스 간 인증이 활성화되어 있는지 확인합니다. 서비스 간 연결이 활성화되어 있고 APIKey를 제공하지 않는 경우 이 플래그를 true로 설정합니다.
API를 사용하여 대상 삭제
다음과 같은 cURL 명령을 사용하여 대상을 삭제할 수 있습니다.
curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
여기서,
<ENDPOINT>는 대상을 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.<TARGET_ID>는 대상의 ID입니다.
예를 들어, 다음의 cURL 요청을 사용하여 ID가 00000000-0000-0000-0000-000000000000인 미국 남부의 대상을 삭제할 수 있습니다.
curl -X DELETE https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
응답에서, 삭제에 성공하면 비어 있는 결과를 받습니다.
{}
API를 사용하여 대상 유효성 검증
다음의 cURL 명령을 사용하여 대상에 쓰기 위한 신임 정보를 검사하여 대상의 유효성을 검증할 수 있습니다.
curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
여기서,
<ENDPOINT>는 대상을 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.<TARGET_ID>는 대상의 ID입니다.
예를 들어, 다음의 cURL 요청을 사용하여 ID가 00000000-0000-0000-0000-000000000000인 미국 남부의 대상을 검증할 수 있습니다.
curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/<TARGETID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
응답에서 write_status`` 섹션에 정보가 표시됩니다. 예를 들면 다음과 같습니다:
"write_status": {
"status": "success"
},
API를 사용하여 대상 보기
다음 cURL 명령을 사용하여 1개의 대상에 대한 구성 세부사항을 볼 수 있습니다.
curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
여기서,
<ENDPOINT>는 대상을 구성하거나 관리할 지역의 API 엔드포인트입니다. 자세한 정보는 엔드포인트를 참조하십시오.<TARGET_ID>는 대상의 ID입니다.
예를 들어, 다음의 cURL 요청을 실행하여 ID가 00000000-0000-0000-0000-000000000000인 대상에 대한 정보를 얻을 수 있습니다.
curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
결과가 COS ("target_type": "cloud_object_storage") 또는 Event Streams ("target_type": "event_streams") 대상인지 표시됩니다.
API를 사용하여 모든 대상 나열
다음과 같은 cURL 명령을 사용하여 모든 대상을 볼 수 있습니다.
curl -X GET <ENDPOINT>/api/v2/targets -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/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"
결과가 COS ("target_type": "cloud_object_storage") 또는 Event Streams ("target_type": "event_streams") 대상인지 표시됩니다.
HTTP 응답 코드
IBM Cloud Activity Tracker Event Routing REST API를 사용하는 경우 표준 HTTP 응답 코드를 가져와서 메소드가 완료되었는지 여부를 표시할 수 있습니다.
- 200 응답은 항상 성공을 나타냅니다.
- 4xx 응답은 실패를 나타냅니다.
- 5xx 응답은 일반적으로 내부 시스템 오류를 나타냅니다.
일부 HTTP 응답 코드는 다음 표를 참조하십시오.
| 상태 코드 | 상태 | 설명 |
|---|---|---|
200 |
OK | 요청이 성공했습니다. |
201 |
OK | 요청이 성공했습니다. 리소스가 작성됩니다. |
400 |
잘못된 요청 | 요청이 실패했습니다. 필요한 매개변수가 누락되었을 수 있습니다. |
401 |
권한 없음 | API 요청에 사용되는 IAM 토큰은 올바르지 않거나 만료되었습니다. |
403 |
금지됨 | 충분하지 않은 권한으로 인해 오퍼레이션이 금지되었습니다. |
404 |
찾을 수 없음 | 요청한 리소스가 존재하지 않거나 이미 삭제되었습니다. |
429 |
요청이 너무 많음 | 너무 많은 요청이 너무 빨리 API에 도달했습니다. |
500 |
내부 서버 오류 | IBM Cloud Activity Tracker Event Routing 처리 중에 문제가 발생했습니다. |
UI를 사용하여 Event Streams 대상 만들기
귀하 계정의 리소스만 나열되고 선택할 수 있습니다. 다른 계정의 리소스를 지정하려면 대상 선택 에서 CRN 지정을 선택합니다.
- IBM Cloud 계정에 로그인하세요.
- 메뉴 아이콘을 클릭하세요.
> 가시성.
- ‘활동 추적’을 선택하세요...
- ‘생성’을 클릭하여 생성 패널을 엽니다.
- 유형 선택: Event Streams 클릭하세요.
- 목적지 선택: 인스턴스별 검색 선택 또는 CRN 지정
- 인스턴스로 검색: 표에서 Event Streams 인스턴스를 선택하거나 만들기 를 클릭하여 새 Event Streams 인스턴스를 만듭니다.
- CRN 지정: Event Streams 인스턴스의 클라우드 리소스 이름(CRN)을 입력하세요. 이를 통해 다른 계정의 CRN을 입력할 수 있습니다.
- 서비스 자격 증명: 서비스 자격 증명 중 하나를 선택하세요. 여기에는 브로커 목록의 사용자 이름, api_key 또는 비밀번호가 포함되어 있습니다.
- Event Streams 주제: 기존 주제를 선택하세요.
- 대상 이름: 대상에 대한 의미 있는 이름을 입력하세요.
- 대상 지역: 이벤트 데이터를 처리할 지역을 선택하세요.
- IBM Cloud Activity Tracker Event Routing 설정에서 새 타겟을 자동으로 기본 타겟으로 설정하려면 기본 타겟으로 설정을 전환하세요. 자세한 내용은 기본 대상 문서를 참조하세요.
- 대상 만들기를 클릭합니다.
UI를 사용하여 Event Streams 대상 업데이트
귀하 계정의 리소스만 나열되고 선택할 수 있습니다. 다른 계정의 리소스를 지정하려면 대상 선택 에서 CRN 지정을 선택합니다.
- IBM Cloud 계정에 로그인하세요.
- 메뉴 아이콘을 클릭하세요.
> 가시성.
- '활동 추적'을 선택하세요.
- 업데이트할 대상을 지정하고
을 클릭합니다.
- 기본값 해제를 클릭하면 IBM Cloud Activity Tracker Event Routing 설정에서 기본 타겟에서 타겟을 제거할 수 있습니다. 자세한 내용은 기본 대상 문서를 참조하세요.
- 편집을 클릭하면 업데이트 패널이 열립니다.
- 세부정보: '편집'을 클릭하여 대상의 이름이나 지역을 업데이트하세요. IBM Cloud Activity Tracker Event Routing 설정에서 기본 타겟을 토글하여 타겟을 기본 타겟으로 추가하거나 제거할 수도 있습니다.
- 저장을 클릭하여 목표를 업데이트하세요.
- 대상: 편집을 클릭하여 대상과 관련된 Event Streams 인스턴스, 서비스 자격 증명 또는 주제를 변경하세요.
- 저장을 클릭하여 목표를 업데이트하세요.
UI를 사용하여 대상 삭제하기
IBM Cloud Activity Tracker Event Routing 대상이 경로에 사용되거나 기본 대상 설정으로 지정된 경우, 해당 대상을 삭제할 수 없습니다.
- IBM Cloud 계정에 로그인하세요.
- 메뉴 아이콘을 클릭하세요.
> 가시성.
- '활동 추적'을 선택하세요.
- 삭제할 대상을 선택한 다음,
클릭합니다.
- 삭제를 클릭한 후 확인 패널에서 삭제를 클릭합니다.
UI를 사용하여 특정 영역 내의 모든 대상을 나열하기
- IBM Cloud 계정에 로그인하세요.
- 메뉴 아이콘을 클릭하세요.
> 가시성.
- '활동 추적'을 선택하세요.
이 표에는 모든 대상에 대한 세부 정보가 나열되어 있습니다:
- 대상 유형
- 대상 이름
- 대상 지역
- 경로: 모든 경로에서 사용되는 경우
- 목표 상태:
- 활성: 대상이 예상대로 작동하고 있습니다.
- 오류: 대상이 잘못 설정되어 이벤트가 대상 위치로 라우팅되지 않습니다. 대상 구성을 수정하거나 더 이상 필요하지 않은 경우 대상을 삭제하려면 대상 세부 정보 또는 목적지를 업데이트하세요.