Config Group Kafka設定の照会

Prev Next

VPC環境で利用できます。

Config Groupの Kafkaの詳細設定を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (韓国リージョン)
POST /api/sgn-v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (シンガポールリージョン)
POST /api/jpn-v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (日本リージョン)

リクエストヘッダ

Cloud Data Streaming Service APIで共通して使用されるヘッダの詳細は、Cloud Data Streaming Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
configGroupNo Integer Required Config Group番号

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
kafkaVersionCode Integer Required Kafkaバージョンコード

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaConfigGroupDetailList/3**' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "kafkaVersionCode": "3903006"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
result.configGroupNo Integer - Config Group番号
result.kafkaVersionCode String - Kafkaバージョンコード
result.additionalKafkaConfigGroupDetailList Array - ユーザー定義詳細設定リスト
result.kafkaConfigGroupDetailList Array - 詳細設定リスト​
requestId String - リクエスト ID
  • UUID形式

additionalKafkaConfigGroupDetailList

additionalKafkaConfigGroupDetailListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
configName String - Config名
  • Kafka設定ファイル(Serverproperties)で使用される名前
type String - Configデータタイプ
range String - Config値の範囲
defaultValue String - Configのデフォルト値
configValue String - Configのユーザー指定値
modifyYn Boolean - ユーザーは変更可能かどうか
  • true | false
    • true: 可能
    • false: 不可

kafkaConfigGroupDetailList

kafkaConfigGroupDetailListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
configNameKey String - Config名キー
configName String - Config名
  • Kafka設定ファイル(Serverproperties)で使用される名前
type String - Configデータタイプ
defaultValue String - Configのデフォルト値
range String - Config値の範囲
customValue String - Configのユーザー指定値
modifyYn Boolean - ユーザーは変更可能かどうか
  • true | false
    • true: 可能
    • false: 不可

レスポンスステータスコード

Cloud Data Streaming Service APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Data Streaming Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "memberNo": "500****",
        "configGroupNo": 3**,
        "kafkaVersionCode": "3903006",
        "additionalKafkaConfigGroupDetailList": [
            {
                "configName": "compression.type",
                "type": "String",
                "range": "[\"lz4\", \"zstd\"]",
                "defaultValue": "lz4",
                "configValue": "",
                "modifyYn": true
            }
        ],
        "kafkaConfigGroupDetailList": [
            {
                "configNameKey": "autoCreateTopicsEnable",
                "configName": "auto.create.topics.enable",
                "type": "Boolean",
                "defaultValue": "true",
                "range": "",
                "customValue": null,
                "modifyYn": true
            },
            {
                "configNameKey": "deleteTopicEnable",
                "configName": "delete.topic.enable",
                "type": "Boolean",
                "defaultValue": "true",
                "range": "",
                "customValue": null,
                "modifyYn": true
            },
            {
                "configNameKey": "offsetsTopicReplicationFactor",
                "configName": "offsets.topic.replication.factor",
                "type": "Integer",
                "defaultValue": "3",
                "range": "1~128",
                "customValue": null,
                "modifyYn": true
            },
            ...
        ]
    },
    "requestId": "1dff09ee-****-****-****-236257061888"
}