Config Groupの照会

Prev Next

VPC環境で利用できます。

Config Groupの詳細情報を照会します。

リクエスト

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

メソッド URI
POST /api/v1/configGroup/getKafkaConfigGroup/{configGroupNo} (韓国リージョン)
POST /api/sgn-v1/configGroup/getKafkaConfigGroup/{configGroupNo} (シンガポールリージョン)
POST /api/jpn-v1/configGroup/getKafkaConfigGroup/{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/getKafkaConfigGroup/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.configGroupNo Integer - Config Group番号
result.memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
result.configGroupName String - Config Group名
result.kafkaVersionCode String - Kafkaバージョンコード
result.description String - Config Groupの説明
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "configGroupNo": 3**,
        "memberNo": "500****",
        "configGroupName": "cg1",
        "kafkaVersionCode": "3903006",
        "description": "config group 1"
    },
    "requestId": "cf182753-****-****-****-68f64cadf730"
}