ConfigGroup Kafka のバージョン別一覧の照会
- 印刷する
- PDF
ConfigGroup Kafka のバージョン別一覧の照会
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
VPC環境で利用できます。
説明
Cloud Data Streaming Serviceの KafkaVersionに応じて使用可能な ConfigGroup情報の照会します。
リクエスト
リクエスト URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/configGroup/getKafkaVersionConfigGroupList [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/configGroup/getKafkaVersionConfigGroupList [JPN]
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | - 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | NAVERクラウドプラットフォームポータルで発行した Access Key ID値x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Access Key ID値と Secret Keyで暗号化した署名x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Request body content typeを application/jsonに指定Content-Type: application/json |
リクエストパラメータ
| パラメータ | タイプ | 要否 | 説明 |
|---|---|---|---|
| kafkaVersionCode | String | Y | - 使用する Cloud Data Streaming Serviceバージョン - getCDSSVersionアクションにより取得できる |
| pageNo | Integer | N | 表示するページ番号(Default: 1) |
| pageSize | Integer | N | 表示するページサイズ(Default: 10) |
リクエスト例
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList
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",
"pageNo": 1,
"pageSize": 10
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList" \
-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",
"pageNo": 1,
"pageSize": 10
}'
レスポンスパラメータ
public class GetKafkaConfigGroupListResponseVo {
private Integer currentPage;
private Boolean isFirst;
private Boolean isLast;
private Integer pageSize;
private Long totalCount;
private Integer totalPage;
private List<KafkaConfigGroup> KafkaConfigGroupList;
}
public class KafkaConfigGroup {
private String kafkaVersionCode;
private String kafkaVersion;
private Integer configGroupNo;
private String configGroupName;
private String description;
}
フィールド
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| currentPage | Integer | 現在のページ番号 |
| isFirst | Boolean | 最初のページであるか否か |
| isLast | Boolean | 最後のページであるか否か |
| pageSize | Integer | ページに表示するデータ数 |
| totalCount | Long | 照会された総データ数 |
| totalPage | Integer | 全体ページ数(totalCount/pageSize) |
| kafkaConfigGroupList | List<KafkaConfigGroup> | ConfigGroup一覧リスト |
| kafkaVersionCode | String | -Cloud Data Streaming Serviceバージョン - getCDSSVersionアクションにより取得できる |
| kafkaVersion | String | 実際の Clusterで使用される Kafka Version |
| configGroupNo | Integer | ConfigGroup番号 |
| configGroupName | String | ConfigGroup名 |
| description | String | ConfigGroupのユーザー Description |
レスポンス例(成功)
{
"code": 0,
"message": "SUCCESS",
"result": {
"currentPage": 1,
"isFirst": true,
"isLast": true,
"pageSize": 10,
"totalCount": 2,
"totalPage": 1,
"kafkaConfigGroupList": [
{
"kafkaVersionCode": "2403005",
"kafkaVersion": "2.4.0",
"configGroupNo": 174,
"configGroupName": "config-test",
"description": "実際のテスト"
},
{
"kafkaVersionCode": "2403005",
"kafkaVersion": "2.4.0",
"configGroupNo": 236,
"configGroupName": "ttttetetet",
"description": "Description修正の追加 "
}
]
},
"requestId": "e1b45201-d865-416d-af16-a7dea176a727"
}
この記事は役に立ちましたか?