커넥터 수정

Prev Next

VPC 환경에서 이용 가능합니다.

커넥터 설정을 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PUT /api/v1/topics/{topicId}/connectors/{connectorId}

요청 헤더

Data Stream API에서 공통으로 사용하는 헤더에 대한 정보는 Data Stream 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
topicId String Required 토픽 아이디
connectorId String Required 커넥터 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
description String Optional 커넥터 설명 (최대 200자)
consumerSpec String Required 컨슈머 사양(커넥터 처리 성능)
  • SMALL | MEDIUM
    • SMALL: 컨테이너 1대로 파티션별 초당 최대 250Kbyte 지원
    • MEDIUM: 컨테이너 2대로 파티션별 초당 최대 500Kbyte 지원
exportType String Required 커넥터 유형
  • OBJECT_STORAGE (유효값)
location String Required 저장 경로
  • s3a://{bucket}/{path} 형태로 입력
includeTopicInPath Boolean Required 저장 경로에 토픽 이름 디렉터리 생성 여부
  • true | false
    • true: 생성
    • false: 생성 안 함
dateFormat String Required 하위 저장 경로에 날짜 포맷 사용 여부
  • NONE | YEAR | MONTH | DAY | HOUR
    • NONE: 사용 안 함
    • YEAR: year={yyyy}/ 사용
    • MONTH: year={yyyy}/month={MM}/ 사용
    • DAY: year={yyyy}/month={MM}/day={dd}/ 사용
    • HOUR: year={yyyy}/month={MM}/day={dd}/hour={HH}/ 사용
roleNrn String Required 커넥터 접근 시 사용되는 Data Stream 서비스의 역할(Role)에 대한 리소스 식별 값
flushInterval Number Optional 스토리지에 메시지 기록 시 파일 생성 주기(분)
  • 1~10 (기본값: 10)
flushCount Number Optional 스토리지에 메시지 기록 시 저장 메시지 수(개)
  • 20~100 (기본값: 100)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PUT 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/connectors/xlThN*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "description": "Connector",
  "consumerSpec": "SMALL",
  "exportType": "OBJECT_STORAGE",
  "location": "s3a://datastream001",
  "includeTopicInPath": true,
  "dateFormat": "NONE",
  "roleNrn": "nrn:PUB:IAM::****:Role/********-36d4-11f0-a3f1-246e966ebeb4",
  "flushInterval": 10,
  "flushCount": 100
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id String - 커넥터 아이디
topicId String - 토픽 아이디
status String - 커넥터 상태
  • RUNNING | FAILED
    • RUNNING: 정상 작동(활성)
    • FAILED: 작동 오류
      • 커넥터 설정 후 버킷을 삭제한 경우
      • 커넥터 설정 후 버킷에 접근 제어를 설정하여 접근이 불가능한 경우
      • 커넥터 설정 후 해당 버킷을 잠금 버킷으로 설정한 경우
connectorName String - 커넥터 이름
description String - 커넥터 설명
consumerSpec String - 컨슈머 사양(커넥터 처리 성능)
  • SMALL | MEDIUM
    • SMALL: 컨테이너 1대로 파티션별 초당 최대 250Kbyte 지원
    • MEDIUM: 컨테이너 2대로 파티션별 초당 최대 500Kbyte 지원
location String - 저장 경로
locationWithTopicName String - 토픽 이름 디렉터리가 포함된 저장 경로
objectStorageLocation String - Object Storage 경로
dateFormat String - 하위 저장 경로에 날짜 포맷 사용 여부
  • NONE | YEAR | MONTH | DAY | HOUR
    • NONE: 사용 안 함
    • YEAR: year={yyyy}/ 사용
    • MONTH: year={yyyy}/month={MM}/ 사용
    • DAY: year={yyyy}/month={MM}/day={dd}/ 사용
    • HOUR: year={yyyy}/month={MM}/day={dd}/hour={HH}/ 사용
exportType String - 커넥터 유형
  • OBJECT_STORAGE (유효값)
includeTopicInPath Boolean - 저장 경로에 토픽 이름 디렉터리 생성 여부
  • true | false
    • true: 생성
    • false: 생성 안 함
createdDate String - 커넥터 생성 일시
  • ISO 8601 형식
  • YYYY-MM-DDThh:mm:ssZ
roleNrn String - 커넥터 접근 시 사용되는 Data Stream 서비스의 역할(Role)에 대한 리소스 식별 값
flushInterval Number - 스토리지에 메시지 기록 시 파일 생성 주기(분)
  • 1~10 (기본값: 10)
flushCount Number - 스토리지에 메시지 기록 시 저장 메시지 수(개)
  • 20~100 (기본값: 100)
groupId String - 커넥터의 컨슈머 그룹 아이디

응답 상태 코드

Data Stream API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Stream 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "id": "xlThNY6P8u",
    "topicId": "mgNWAoFEja",
    "status": "RUNNING",
    "connectorName": "connector-h4j6l-ds001",
    "description": "Connector",
    "consumerSpec": "SMALL",
    "location": "s3a://datastream001",
    "locationWithTopicName": "s3a://datastream001",
    "objectStorageLocation": "https://console.ncloud.com/objectStorage/objectStorageList?bucketName=datastream001&folderPrefix=",
    "dateFormat": "NONE",
    "exportType": "OBJECT_STORAGE",
    "includeTopicInPath": false,
    "createdDate": "2025-06-05T12:56:45Z",
    "roleNrn": "nrn:PUB:IAM::****:Role/********-36d4-11f0-a3f1-246e966ebeb4",
    "flushInterval": 10,
    "flushCount": 100,
    "groupId": "connect-h4j6l-ds001"
}