View list of Config Group Kafka properties

Article summary

Did you find this summary helpful?

Thank you for your feedback

It is available in a VPC environment.

Description

Views the detailed settings of Kafka that can be changed for the ConfigGroup of Cloud Data Streaming Service.

Request

Request URL

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

Request header

Header name	Description
x-ncp-apigw-timestamp	This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Value of access key ID issued on the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Specifies the request body content type as application/json `Content-Type: application/json`

Request parameter

Parameter	Type	Requirement status	Description
configGroupNo	String	Y	- ConfigGroupNo Number of the target ConfigGroup
kafkaVersionCode	String	Y	- Cloud Data Streaming Service version to be used It can be acquired through the getCDSSVersion action.

Request examples

POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/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/cluster/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"
}'

Response parameter

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;
}

Field

Parameter name	Type	Description
memberNo	String	Member number
configGroupNo	Integer	ConfigGroup number
kafkaVersionCode	String	Cloud Data Streaming Service version to be used It can be acquired through the getCDSSVersion action.
kafkaConfigGroupDetailList	List<KafkaConfigDetail>	List of configs that can be used in ConfigGroup
configNameKey	String	Config name key Name for processing in an API
configName	String	Config name Config name used in Server Properties
type	String	Type of ConfigValue
defaultValue	String	Default value of ConfigValue
range	String	Range of ConfigValue
customValue	String	Value saved by the user of ConfigValue
modifyYn	Boolean	User editable status of ConfigValue (N indicates that the customer can't edit it)

Response examples (success)

{
  "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"
}

Was this article helpful?

What's Next

Save Config Group Kafka properties settings

Table of contents

Description
Request
Response parameter
Field