ConfigGroup Kafka Properties 목록 조회

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

설명

Cloud Data Streaming Service의 ConfigGroup의 변경 가능한 Kafka 상세 설정을 조회합니다.

요청

요청 URL

POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-
v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} [JPN]

요청 헤더

헤더명	설명
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 파라미터

파라미터	타입	필수 여부	설명
configGroupNo	String	Y	- ConfigGroupNo - 대상 ConfigGroup 의 번호
kafkaVersionCode	String	Y	- 사용할 Cloud Data Streaming Service 버전 - getCDSSVersion 액션을 통해 획득 가능

요청 예시

POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaConfigGroupDetailList/174
HOST: clouddatastreamingservice.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=
x-ncp-apigw-timestamp: 1653981745173
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw

{
  "kafkaVersionCode": "2403005"
}

curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaConfigGroupDetailList/174" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2" \
-H "x-ncp-apigw-timestamp: 1653981745173" \
-H "x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=" \
-d \
'{
  "kafkaVersionCode": "2403005"
}'

응답 파라미터

public class GetKafkaConfigGroupDetailListResponseVo {
    private String memberNo;
    private Integer configGroupNo;
    private String kafkaVersionCode;
    private List<KafkaConfigDetail> KafkaConfigGroupDetailList;
}

public class KafkaConfigDetail {
    private String configNameKey;
    private String configName;
    private String type;
    private String defaultValue;
    private String range;
    private String customValue;
    private Boolean modifyYn;
}

필드

파라미터명	타입	설명
memberNo	String	Member 번호
configGroupNo	Integer	ConfigGroup 번호
kafkaVersionCode	String	- 사용할 Cloud Data Streaming Service 버전 - getCDSSVersion 액션을 통해 획득 가능
kafkaConfigGroupDetailList	List<KafkaConfigDetail>	ConfigGroup 에서 사용할 수 있는 Config 리스트
configNameKey	String	- Config 이름 키 - API에서 처리 하기 위한 이름
configName	String	- Config 이름 - Server Properties에서 사용되는 config 이름
type	String	ConfigValue 타입
defaultValue	String	ConfigValue 기본 값
range	String	ConfigValue의 범위
customValue	String	ConfigValue의 사용자가 저장한 값
modifyYn	Boolean	ConfigValue의 사용자 수정 가능 여부(n은 고객이 수정할 수 없음)

응답 예시(성공)

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "memberNo": "46",
    "configGroupNo": 174,
    "kafkaVersionCode": "2403005",
    "kafkaConfigGroupDetailList": [
      {
        "configNameKey": "autoCreateTopicsEnable",
        "configName": "auto.create.topics.enable",
        "type": "Boolean",
        "defaultValue": "true",
        "range": "",
        "customValue": "true",
        "modifyYn": true
      },
      {
        "configNameKey": "deleteTopicEnable",
        "configName": "delete.topic.enable",
        "type": "Boolean",
        "defaultValue": "true",
        "range": "",
        "customValue": "true",
        "modifyYn": true
      },
      {
        "configNameKey": "logCleanerEnable",
        "configName": "log.cleaner.enable",
        "type": "Boolean",
        "defaultValue": "true",
        "range": "",
        "customValue": "true",
        "modifyYn": true
      },
      {
        "configNameKey": "logCleanupPolicy",
        "configName": "log.cleanup.policy",
        "type": "String",
        "defaultValue": "delete",
        "range": "[\"delete\", \"compact\"]",
        "customValue": "delete",
        "modifyYn": true
      },
      {
        "configNameKey": "logCleanerThreads",
        "configName": "log.cleaner.threads",
        "type": "Integer",
        "defaultValue": "1",
        "range": "1~100",
        "customValue": "1",
        "modifyYn": true
      },
      {
        "configNameKey": "logFlushIntervalMessages",
        "configName": "log.flush.interval.messages",
        "type": "Long",
        "defaultValue": "9223372036854775807",
        "range": "1~9223372036854775807",
        "customValue": "9223372036854775807",
        "modifyYn": true
      },
      {
        "configNameKey": "logRetentionBytes",
        "configName": "log.retention.bytes",
        "type": "Long",
        "defaultValue": "-1",
        "range": "-1~9223372036854775807",
        "customValue": "-1",
        "modifyYn": true
      },
      {
        "configNameKey": "logRetentionHours",
        "configName": "log.retention.hours",
        "type": "Integer",
        "defaultValue": "168",
        "range": "1~168",
        "customValue": "168",
        "modifyYn": true
      },
      {
        "configNameKey": "logSegmentBytes",
        "configName": "log.segment.bytes",
        "type": "Integer",
        "defaultValue": "1073741824",
        "range": "1~2147483647",
        "customValue": "1073741824",
        "modifyYn": true
      },
      {
        "configNameKey": "numIoThreads",
        "configName": "num.io.threads",
        "type": "Integer",
        "defaultValue": "8",
        "range": "1~2147483647",
        "customValue": "8",
        "modifyYn": true
      },
      {
        "configNameKey": "numNetworkThreads",
        "configName": "num.network.threads",
        "type": "Integer",
        "defaultValue": "3",
        "range": "1~2147483647",
        "customValue": "3",
        "modifyYn": true
      },
      {
        "configNameKey": "numPartitions",
        "configName": "num.partitions",
        "type": "Integer",
        "defaultValue": "3",
        "range": "1~128",
        "customValue": "3",
        "modifyYn": true
      },
      {
        "configNameKey": "authorizerClassName",
        "configName": "authorizer.class.name",
        "type": "String",
        "defaultValue": "kafka.security.authorizer.AclAuthorizer",
        "range": "1~50",
        "customValue": null,
        "modifyYn": false
      },
      {
        "configNameKey": "allowEveryoneIfNoAclFound",
        "configName": "allow.everyone.if.no.acl.found",
        "type": "Boolean",
        "defaultValue": "true",
        "range": "",
        "customValue": "true",
        "modifyYn": true
      }
    ]
  },
  "requestId": "4584817c-2a1b-4824-8bcc-80ad236c13a5"
}

이 문서가 도움이 되었습니까?

What's Next

ConfigGroup Kafka Properties 설정 저장

설명
요청
응답 파라미터
필드

태그