CLI 전제조건

CLI를 사용하여 대상을 관리하기 전에 다음 단계를 완료하십시오.

1. IBM Cloud CLI를 설치하십시오.

2. IBM Cloud Activity Tracker Event Routing CLI를 설치하십시오.

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

동일한 계정 내에서 UI를 사용하여 S2S 인증 설정하기

IBM Cloud UI를 사용하여 서비스 대 서비스 권한을 구성하려면 다음을 수행하십시오.

1. IBM Cloud Activity Tracker Event Routing 대상을 구성할 계정 소유자로 IBM Cloud 계정에 로그인하십시오.

   사용자 ID와 비밀번호로 로그인하면 IBM Cloud 대시보드가 열립니다.

2. ‘관리’ > ‘액세스(IAM)’ > ‘권한’을 선택합니다.

3. 작성을 클릭하십시오.

4. '소스 서비스 '에서 다음을 선택하십시오. Activity Tracker 를 선택하고, '액세스 범위를 어떻게 설정하시겠습니까?' 항목에서는 '모든 리소스'를 선택하십시오.

5. 대상 서비스 에서 다음을 선택하십시오. App Configuration 그리고 '접근 범위를 어떻게 설정하시겠습니까? ' 항목에서 '선택한 속성을 기반으로 한 리소스'를 선택하십시오.

6. 서비스 인스턴스를 선택하고 문자열이 일치하는지 확인합니다. IBM Cloud App Configuration 인스턴스의 이름을 설정하십시오.

7. 서비스 액세스를 위해 ‘관리자’ 및 ‘구성 업데이트 리포터’ 역할을 선택하십시오.

8. 권한 부여를 클릭하십시오. 새 서비스 대 서비스 권한이 인증 관리 보기에 나열됩니다.

CLI를 사용하여 S2S 인증 구성하기

IBM Cloud CLI를 사용하여 서비스 대 서비스 권한을 구성하려면 다음을 수행하십시오.

1. IBM Cloud 계정에 로그인하세요 IBM Cloud Activity Tracker Event Routing 인증을 설정할 계정 소유자로서.

2. 서비스 대 서비스 권한을 정의하는 권한 정책을 작성하십시오.

   ibmcloud iam authorization-policy-create atracker apprapp "ConfigurationUpdateReporter" [--target-service-instance-id <APPCONFIG_SERVICE_INSTANCE>
   

API를 사용하여 S2S 인증 구성하기

IBM Cloud API를 사용하여 서비스 대 서비스 권한을 구성하려면 다음을 수행하십시오.

1. IBM Cloud Activity Tracker Event Routing IAM 권한을 구성할 계정 소유자로 IBM Cloud 계정에 로그인하십시오.

2. 서비스 대 서비스 권한을 정의하는 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:ConfigurationUpdateReporter"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "apprapp"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "APPCONFIG_SERVICE_INSTANCE"
                   }
               ]
           }
       ]
   }
   

   여기서:

   CUSTOMER_ACCOUNT_ID은(는) 대상을 구성할 계정의 계정 GUID입니다. ibmcloud account list 명령을 사용하여 이를 찾을 수 있습니다.

   APPCONFIG_SERVICE_INSTANCE IBM Cloud App Configuration 인스턴스의 인스턴스 ID입니다.

3. IAM 액세스 토큰을 가져오십시오. 자세한 정보는 IAM 액세스 토큰 검색을 참조하십시오.

4. 다음의 명령을 실행하여 서비스 대 서비스 권한을 구성하십시오.

   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를 사용하여 IBM Cloud App Configuration 타깃 생성하기

이 명령어를 사용하여 활동 이벤트의 전송 대상을 구성하는 데 사용할 ‘ IBM Cloud App Configuration ’ 타깃을 생성합니다.

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn APPCONFIG_TARGET_CRN] ) ) [--region REGION] [--output FORMAT]

OK
Target
Name:                         my-target
ID:                           000000000-00000000-0000-0000-00000000
CRN:                          crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                       us-south
Type:                         app_config
App Configuration Target CRN: crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                 success
CreatedAt:                    2024-05-31T19:03:35.427Z
UpdatedAt:                    2024-05-31T19:03:35.427Z

CLI를 사용하여 IBM Cloud App Configuration 타깃 업데이트하기

이 명령어를 사용하여 IBM Cloud Activity Tracker Event Routing 리전의 ‘ IBM Cloud App Configuration ’ 타깃을 업데이트하십시오. 대상이 원래 작성되었던 때와는 다르게 지정된 값이 명령에 지정된 값으로 업데이트됩니다.

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | [--target-crn APPCONFIG_TARGET_CRN]] [--output FORMAT]

OK
Target
Name:                         new-target-name
ID:                           000000000-00000000-0000-0000-00000000
CRN:                          crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                       us-south
Type:                         app_config
App Configuration Target CRN: crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                 success
Created:                      2024-05-31T19:03:35.427Z
Updated:                      2024-05-31T19:03:35.427Z

CLI를 사용하여 대상 삭제

이 명령을 사용하여 대상을 삭제할 수 있습니다.

ibmcloud atracker target rm --target TARGET [--force]

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.

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
Name:                            new-target-name
ID:                              xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                             crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:                            app_config
App Configuration Target CRN:    crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Service to Service Enabled:      true
Write Status:                    success
Created:                         2021-07-21T16:04:15.174Z
Updated:                         2021-07-21T17:49:56.452Z

CLI를 사용하여 대상에 대한 정보 얻기

이 명령을 사용하여 IBM Cloud Activity Tracker Event Routing 지역의 대상에 대한 정보를 얻으십시오.

ibmcloud atracker target get --target TARGET [--output FORMAT]

Target
Name:                            new-target-name
ID:                              xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                             crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                          us-east
Type:                            app_config
App Configuration Target CRN:    crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                    success
Created:                         2024-06-02T16:04:15.174Z
Updated:                         2024-06-05T17:49:56.452Z

지역의 모든 대상 나열

이 명령을 사용하여 IBM Cloud Activity Tracker Event Routing 지역에 구성된 대상을 나열하십시오.

ibmcloud atracker target ls [--output FORMAT]

Name                       ID                                     Region     Type                Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south   app_config   2020-11-18T03:52:08.603Z

API 대상 및 조치

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

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

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

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

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

REST API에 대한 자세한 정보는 대상을 참조하십시오.

API 전제조건

대상을 관리하는 API 호출을 수행하려면 다음 단계를 완료하십시오.

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

API를 사용하여 IBM Cloud App Configuration 타깃 생성하기

다음과 같은 cURL 명령어를 사용하여 IBM Cloud App Configuration 타깃을 생성할 수 있습니다:

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "APPCONFIG_CRN"
    }
  }'

여기서,

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

• TARGET_NAME은 대상의 이름입니다. 이름의 최대 길이는 256자입니다.

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

• TARGET_TYPE은 대상의 유형입니다.

• app_config_endpoint에는 대상에 대한 정보가 포함되어 있습니다.

APPCONFIG_CRN IBM Cloud App Configuration 인스턴스의 CRN 을 나타냅니다.

예를 들어, 다음과 같은 cURL 요청을 사용하여 댈러스에서 대상을 작성할 수 있습니다.

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My App Configuration target",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

응답에서 대상의 GUID를 표시하는 id, 대상의 CRN을 표시하는 crn과 같은 대상에 대한 정보를 얻습니다.

API를 사용하여 IBM Cloud App Configuration 타겟 업데이트하기

IBM Cloud App Configuration 타깃을 업데이트할 때는 요청의 데이터 섹션에 해당 타깃 정보를 포함해야 합니다.

• 모든 필드를 전달해야 합니다.
• 변경해야 하는 필드를 업데이트하십시오.
• 일단 작성되면 대상의 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": "app_config",
    "app_config_endpoint": {
      "target_crn": "APPCONFIG_CRN"
    }
  }'

여기서,

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

• TARGET_ID는 대상의 ID입니다.

• TARGET_NAME은 대상의 이름입니다. 이름의 최대 길이는 256자입니다.

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

• TARGET_TYPE은 대상의 유형입니다. IBM Cloud App Configuration 타깃의 경우 값을 app_config 로 설정하십시오.

• app_config_endpoint에는 대상에 대한 정보가 포함되어 있습니다.

APPCONFIG_CRN IBM Cloud App Configuration 인스턴스의 CRN 을 나타냅니다.

예를 들어, 다음의 cURL 요청을 사용하여 달라스에서 대상을 업데이트할 수 있습니다.

curl -X PUT   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/TARGET_ID   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My new App Configuration target name",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

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"), IBM Cloud Logs 상품("target_type": "cloud_logs") 또는 IBM Cloud App Configuration ("target_type": "app_config") 중 어느 것인지 확인됩니다

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"), IBM Cloud Logs 상품("target_type": "cloud_logs") 또는 IBM Cloud App Configuration ("target_type": "app_config") 중 어느 것인지 확인됩니다

HTTP 응답 코드

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

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

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