ConfigGroup Kafka Propertiesリストの照会
- 印刷する
- PDF
ConfigGroup Kafka Propertiesリストの照会
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
VPC環境で利用できます。
説明
Cloud Data Streaming ServiceのConfigGroup変更できるKafkaの詳細設定を照会します。
リクエスト
リクエストURL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroupDetailList/{configGroupNo} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getKafkaConfigGroupDetailList/{configGroupNo} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getKafkaConfigGroupDetailList/{configGroupNo} [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 | リクエストボディのコンテンツタイプをapplication/jsonに指定Content-Type: application/json |
リクエストパラメータ
| パラメータ | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| configGroupNo | String | Y | - ConfigGroupNo 対象ConfigGroupの番号 |
| kafkaVersionCode | String | Y | - 使用するCloud Data Streaming Serviceバージョン getCDSSVersionアクションを通じて取得可能 |
リクエスト例
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroupDetailList/174
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"
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroupDetailList/174" \
-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"
}'
レスポンスパラメータ
public class GetKafkaConfigGroupDetailListResponseVo {
private String memberNo;
private Integer configGroupNo;
private String kafkaVersionCode;
private List<KafkaConfigDetail> KafkaConfigGroupDetailList;
}
public class KafkaConfigDetail {
private String configNameKey;
private String configName;
private String type;
private String defaultValue;
private String range;
private String customValue;
private Boolean modifyYn;
}
フィールド
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| memberNo | String | Member番号 |
| configGroupNo | Integer | ConfigGroup番号 |
| kafkaVersionCode | String | 使用するCloud Data Streaming Serviceバージョン getCDSSVersionアクションを通じて取得可能 |
| kafkaConfigGroupDetailList | List<KafkaConfigDetail> | ConfigGroupで使用できるConfigリスト |
| configNameKey | String | Config名キー APIで処理するための名前 |
| configName | String | Config名 Server Propertiesで使用されるconfig名 |
| type | String | ConfigValueのタイプ |
| defaultValue | String | ConfigValueのデフォルト値 |
| range | String | ConfigValueの範囲 |
| customValue | String | ConfigValueのユーザーが保存した値 |
| modifyYn | Boolean | ConfigValueのユーザー修正の可不可(nは顧客が修正できない) |
レスポンス例(成功)
{
"code": 0,
"message": "SUCCESS",
"result": {
"memberNo": "46",
"configGroupNo": 174,
"kafkaVersionCode": "2403005",
"kafkaConfigGroupDetailList": [
{
"configNameKey": "autoCreateTopicsEnable",
"configName": "auto.create.topics.enable",
"type": "Boolean",
"defaultValue": "true",
"range": "",
"customValue": "true",
"modifyYn": true
},
{
"configNameKey": "deleteTopicEnable",
"configName": "delete.topic.enable",
"type": "Boolean",
"defaultValue": "true",
"range": "",
"customValue": "true",
"modifyYn": true
},
{
"configNameKey": "logCleanerEnable",
"configName": "log.cleaner.enable",
"type": "Boolean",
"defaultValue": "true",
"range": "",
"customValue": "true",
"modifyYn": true
},
{
"configNameKey": "logCleanupPolicy",
"configName": "log.cleanup.policy",
"type": "String",
"defaultValue": "delete",
"range": "[\"delete\", \"compact\"]",
"customValue": "delete",
"modifyYn": true
},
{
"configNameKey": "logCleanerThreads",
"configName": "log.cleaner.threads",
"type": "Integer",
"defaultValue": "1",
"range": "1~100",
"customValue": "1",
"modifyYn": true
},
{
"configNameKey": "logFlushIntervalMessages",
"configName": "log.flush.interval.messages",
"type": "Long",
"defaultValue": "9223372036854775807",
"range": "1~9223372036854775807",
"customValue": "9223372036854775807",
"modifyYn": true
},
{
"configNameKey": "logRetentionBytes",
"configName": "log.retention.bytes",
"type": "Long",
"defaultValue": "-1",
"range": "-1~9223372036854775807",
"customValue": "-1",
"modifyYn": true
},
{
"configNameKey": "logRetentionHours",
"configName": "log.retention.hours",
"type": "Integer",
"defaultValue": "168",
"range": "1~168",
"customValue": "168",
"modifyYn": true
},
{
"configNameKey": "logSegmentBytes",
"configName": "log.segment.bytes",
"type": "Integer",
"defaultValue": "1073741824",
"range": "1~2147483647",
"customValue": "1073741824",
"modifyYn": true
},
{
"configNameKey": "numIoThreads",
"configName": "num.io.threads",
"type": "Integer",
"defaultValue": "8",
"range": "1~2147483647",
"customValue": "8",
"modifyYn": true
},
{
"configNameKey": "numNetworkThreads",
"configName": "num.network.threads",
"type": "Integer",
"defaultValue": "3",
"range": "1~2147483647",
"customValue": "3",
"modifyYn": true
},
{
"configNameKey": "numPartitions",
"configName": "num.partitions",
"type": "Integer",
"defaultValue": "3",
"range": "1~128",
"customValue": "3",
"modifyYn": true
},
{
"configNameKey": "authorizerClassName",
"configName": "authorizer.class.name",
"type": "String",
"defaultValue": "kafka.security.authorizer.AclAuthorizer",
"range": "1~50",
"customValue": null,
"modifyYn": false
},
{
"configNameKey": "allowEveryoneIfNoAclFound",
"configName": "allow.everyone.if.no.acl.found",
"type": "Boolean",
"defaultValue": "true",
"range": "",
"customValue": "true",
"modifyYn": true
}
]
},
"requestId": "4584817c-2a1b-4824-8bcc-80ad236c13a5"
}
この記事は役に立ちましたか?