Config Groupリストの照会

VPC環境で利用できます。

Kafkaバージョンごとに作成した Config Groupリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`kafkaVersionCode`	Integer	Required	Kafkaバージョンコードバージョンの照会を参照
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~N (デフォルト: 10)

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList' \
--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",
  "pageNo": 1,
  "pageSize": 10
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	レスポンスコード
`message`	String	-	レスポンスメッセージ
`result`	Object	-	レスポンス結果
`result.currentPage`	Integer	-	現在のページ番号
`result.isFirst`	Boolean	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`result.isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`result.pageSize`	Integer	-	ページ表示数
`result.totalCount`	Integer	-	レスポンス結果数
`result.totalPage`	Integer	-	ページの総数
`result.kafkaConfigGroupList`	Array	-	Config Groupリスト
`requestId`	String	-	リクエスト ID UUID形式

`kafkaConfigGroupList`

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

フィールド	タイプ	必須の有無	説明
`kafkaVersionCode`	Integer	-	Kafkaバージョンコード
`kafkaVersion`	String	-	Kafkaバージョン
`configGroupNo`	Integer	-	Config Group番号
`configGroupName`	String	-	Config Group名
`description`	String	-	Config Groupの説明

参考

permissionはレスポンス結果に表示される場合がありますが、ユーザーが参照すべきフィールドではありません。

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 1,
        "totalPage": 1,
        "kafkaConfigGroupList": [
            {
                "kafkaVersionCode": "3903006",
                "kafkaVersion": "3.9.0",
                "configGroupNo": 3**,
                "configGroupName": "cg1",
                "description": "config group 1",
                "permission": "Allow"
            }
        ]
    },
    "requestId": "34926977-****-****-****-ff0ad6816d93"
}