Config Groupの説明の変更

Prev Next

VPC環境で利用できます。

Config Groupの説明を変更します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
kafkaVersionCode Integer Required Kafkaバージョンコード
description String Optional Config Groupの説明
  • 0~255文字

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/setKafkaConfigGroupMemo/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",
  "description": "Config group 1"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "60221c3d-****-****-****-2acde6fe6718"
}