[Ultimate]{class="badge positive"}

흐름 서비스 API를 사용하여 Amazon Kinesis 소스 연결 만들기

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:

작성 대상:

개발자

IMPORTANT

Amazon Kinesis 원본은 Real-time Customer Data Platform Ultimate를 구입한 사용자가 소스 카탈로그에서 사용할 수 있습니다.

이 자습서에서는 Flow Service API를 사용하여 Amazon Kinesis (이하 "Kinesis")을(를) Experience Platform에 연결하는 단계를 안내합니다.

시작하기

이 안내서를 사용하려면 Adobe Experience Platform의 다음 구성 요소에 대해 이해하고 있어야 합니다.

소스: Experience Platform을 사용하면 Platform 서비스를 사용하여 들어오는 데이터를 구조화하고 레이블을 지정하고 개선하는 기능을 제공하는 동시에 다양한 소스에서 데이터를 수집할 수 있습니다.
샌드박스: Experience Platform은 단일 Platform 인스턴스를 별도의 가상 환경으로 분할하여 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 되는 가상 샌드박스를 제공합니다.

다음 섹션에서는 Flow Service API를 사용하여 Kinesis을(를) 플랫폼에 성공적으로 연결하기 위해 알아야 할 추가 정보를 제공합니다.

필요한 자격 증명 수집

Flow Service이(가) Amazon Kinesis 계정에 연결하려면 다음 연결 속성에 대한 값을 제공해야 합니다.

자격 증명

설명

accessKeyId

액세스 키 ID는 Kinesis 계정을 Platform에 인증하는 데 사용되는 액세스 키 쌍의 절반입니다.

secretKey

보안 액세스 키는 Kinesis 계정을 Platform에 인증하는 데 사용되는 액세스 키 쌍의 나머지 절반입니다.

region

Kinesis 계정의 지역입니다. 지역에 대한 자세한 내용은 허용 목록에 IP 주소 추가에 대한 안내서를 참조하십시오.

connectionSpec.id

연결 사양은 기본 및 소스 연결 만들기와 관련된 인증 사양을 포함하여 소스의 커넥터 속성을 반환합니다. Kinesis 연결 사양 ID: 86043421-563b-46ec-8e6c-e23184711bf6.

Kinesis 액세스 키 및 생성 방법에 대한 자세한 내용은 이 AWS IAM 사용자에 대한 액세스 키 관리 가이드를 참조하십시오.

Platform API 사용

Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 Platform API 시작에 대한 안내서를 참조하십시오.

기본 연결 만들기

원본 연결을 만드는 첫 번째 단계는 Kinesis 원본을 인증하고 기본 연결 ID를 생성하는 것입니다. 기본 연결 ID를 사용하면 소스 내에서 파일을 탐색 및 탐색하고 데이터 유형 및 형식에 대한 정보를 포함하여 수집할 특정 항목을 식별할 수 있습니다.

기본 연결 ID를 만들려면 Kinesis 인증 자격 증명을 요청 매개 변수의 일부로 제공하는 동안 /connections 끝점에 POST 요청을 하십시오.

API 형식

POST /connections

요청

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Amazon Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
        "auth": {
            "specName": "Aws Kinesis authentication credentials",
            "params": {
                "accessKeyId": "{ACCESS_KEY_ID}",
                "secretKey": "{SECRET_KEY}",
                "region": "{REGION}"
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'

속성

설명

auth.params.accessKeyId

Kinesis 계정의 액세스 키 ID입니다.

auth.params.secretKey

Kinesis 계정의 비밀 액세스 키입니다.

auth.params.region

Kinesis 계정의 지역입니다.

connectionSpec.id

Kinesis 연결 사양 ID: 86043421-563b-46ec-8e6c-e23184711bf6

응답

성공한 응답은 고유 식별자(id)를 포함하여 새로 만든 기본 연결의 세부 정보를 반환합니다. 다음 단계에서 소스 연결을 만들려면 이 ID가 필요합니다.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

소스 연결 만들기 source

소스 연결은 데이터가 수집되는 외부 소스와의 연결을 만들고 관리합니다. 소스 연결은 데이터 소스, 데이터 형식 및 데이터 흐름을 만드는 데 필요한 소스 연결 ID와 같은 정보로 구성됩니다. 소스 연결 인스턴스는 테넌트 및 조직에만 해당됩니다.

소스 연결을 만들려면 Flow Service API의 /sourceConnections 끝점에 대한 POST 요청을 만듭니다.

API 형식

POST /sourceConnections

요청

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "AWS Kinesis source connection",
        "description": "A source connection for AWS Kinesis",
        "baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "stream": "{STREAM}",
            "dataType": "raw",
            "reset": "latest"
        }
    }'

속성

설명

name

소스 연결의 이름입니다. 소스 연결에 대한 정보를 조회할 때 소스 연결의 이름이 설명적인지 확인합니다.

description

소스 연결에 대한 자세한 정보를 포함하도록 제공할 수 있는 선택적 값입니다.

baseConnectionId

이전 단계에서 생성된 Kinesis 소스의 기본 연결 ID입니다.

connectionSpec.id

Kinesis에 대한 고정 연결 사양 ID입니다. 이 ID: 86043421-563b-46ec-8e6c-e23184711bf6

data.format

수집할 Kinesis 데이터의 형식입니다. 현재 지원되는 데이터 형식은 json뿐입니다.

params.stream

레코드를 가져올 데이터 스트림의 이름입니다.

params.dataType

이 매개 변수는 수집되는 데이터의 유형을 정의합니다. 지원되는 데이터 형식은 raw 및 xdm입니다.

params.reset

이 매개 변수는 데이터를 읽는 방법을 정의합니다. latest을(를) 사용하여 가장 최근 데이터에서 읽기를 시작하고 earliest을(를) 사용하여 스트림에서 사용 가능한 첫 번째 데이터에서 읽기를 시작합니다.

응답

성공한 응답은 새로 만든 원본 연결의 고유 식별자(id)를 반환합니다. 데이터 흐름을 만들려면 다음 자습서에서 이 ID가 필요합니다.

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

다음 단계

이 자습서에 따라 Flow Service API를 사용하여 Kinesis 소스 연결을 만들었습니다. 다음 자습서에서 이 원본 연결 ID를 사용하여 API를 사용하여 스트리밍 데이터 흐름을 만들 Flow Service 수 있습니다.

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089