Cloud Data Streaming Service Clusterリストの照会
- 印刷する
- PDF
Cloud Data Streaming Service Clusterリストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
説明
Cloud Data Streaming Service Clusterリストを照会します。
リクエスト
リクエストURL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [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 | リクエストボディーcontent typeをapplication/jsonに指定Content-Type: application/json |
リクエストパラメータ
パラメータ | タイプ | 必須有無 | 説明 |
---|---|---|---|
inputText | String | N | 照会するクラスタ名です。 |
vpcName | String | N | 当該VPCを使用しているクラスタを照会します。 |
pageNo | Integer | N | ページ番号です。Default : 1 ex) 1, 2 |
pageSize | Integer | N | ページサイズです。Defatlt : 10 ex) 10, 20 |
リクエスト例
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList
HOST: clouddatastreamingservice.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
{
"inputText" : "open",
"vpcName": "test",
"pageNo" : 1,
"pageSize" : 10
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList?pageNo=1&pageSize=10 \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" \
-d \
'{
"inputText" : "open",
"vpcName": "test",
"pageNo" : 1,
"pageSize" : 10
}'
レスポンスパラメータ
public class GetClusterInfoListResponseVo {
private List<AllowedClusterInfo> allowedClusters;
private List<DisallowedClusterInfo> disallowedClusters;
private Integer currentPage;
private Boolean isFirst;
private Boolean isLast;
private Integer pageSize;
private Long totalCount;
private Integer totalPage;
}
public class AllowedClusterInfo {
private String clusterName;
private String brokerNodeType;
private String brokerNodeProductName;
private Integer brokerNodeCount;
private String applicationVersion;
private String kafkaVersion;
private String cmakVersion;
private String softwareProductName;
private Date createDate;
private String managerNodeType;
private Integer managerNodeCount;
private String clusterPublicDomain;
private Boolean isUsePublicDomain;
private Long dataStorageVolumeSize;
private Integer managerNodeAccessControlGroupSequence;
private String managerNodeAccessControlGroupName;
private Integer brokerNodeAccessControlGroupSequence;
private String brokerNodeAccessControlGroupName;
private Integer kafkaBrokerPort;
private Integer kafkaBrokerTlsPort;
private Integer zookeeperPort;
private Integer cmakPort;
private String serviceGroupInstanceNo;
private String kafkaManagerUserName;
private String memberNo;
private String vpcName;
private Integer vpcNo;
private String managerNodeSubnetName;
private Integer managerNodeSubnetNo;
private String brokerNodeSubnetNo;
private Integer brokerNodeSubnetNo;
private Integer configGroupNo;
private String configGroupName;
}
public class DisallowedClusterInfo {
private String clusterName;
private String serviceGroupInstanceNo;
}
フィールド
パラメータ名 | タイプ | 説明 |
---|---|---|
serviceGroupInstanceNo | String | 作成されたクラスタのserviceGroupInstanceNo |
allowedClusters | List | クラスタリスト |
disallowedClusters | List | Subaccountで呼び出す際、getClusterDetail権限がないクラスタリスト |
currentPage | Integer | 現在のページ |
isFirst | Boolean | firstページかどうか |
isLast | Boolean | lastページかどうか |
pageSize | Integer | ページのサイズ |
totalCount | Long | クラスタの総リスト数 |
totalPage | Integer | 総ページ数 |
clusterName | String | クラスタ名 |
brokerNodeType | String | ブローカーノードタイプ |
brokerNodeProductName | String | ブローカーノードタイプ名 |
brokerNodeCount | Integer | ブローカーノード数 |
applicationVersion | String | Cloud Data Streaming Serviceバージョン |
cmakVersion | String | CMAKバージョン |
kafkaVersion | String | Kafkaバージョン |
softwareProductName | String | OS商品名 |
createDate | Date | 作成日時 |
managerNodeType | String | マネージャーノードタイプ |
managerNodeCount | Integer | マネージャーノード数 |
clusterPublicDomain | String | クラスタ接続Domain |
isUsePublicDomain | Boolean | Public Domain使用するかどうか |
brokerStorageVolumeSize | Long | ブローカーノードのストレージ容量 |
managerNodeAccessControlGroupSequence | Integer | マネージャーノードのACG番号 |
managerNodeAccessControlGroupName | String | マネージャーノードのACG名 |
brokerNodeAccessControlGroupSequence | Integer | ブローカーノードのACG番号 |
brokerNodeAccessControlGroupName | String | ブローカーノードのACG名 |
kafkaBrokerPort | String | ブローカーノードのPort |
kafkaBrokerTlsPort | String | ブローカーノードのTLS Port |
zookeeperPort | String | ZooKeeperノードのPort |
cmakPort | String | CMAKアクセスPort |
serviceGroupInstanceNo | String | クラスタインスタンス番号 |
kafkaManagerUserName | String | CMAKアクセスID |
memberNo | String | お客様番号 |
vpcName | String | サーバが位置しているVPC名 |
vpcNo | Integer | サーバが位置しているVPC番号 |
managerNodeSubnetName | String | マネージャーノードが位置しているSubnet名 |
managerNodeSubnetNo | Integer | マネージャーノードが位置しているSubnet番号 |
brokerNodeSubnetName | String | ブローカーノードが位置しているSubnet名 |
brokerNodeSubnetNo | Integer | ブローカーノードが位置しているSubnet番号 |
conifgGroupNo | Integer | ConfigGroup番号 |
conifgGroupName | String | ConfigGroup名 |
レスポンス例
{
"code": 0,
"message": "SUCCESS",
"result": {
"currentPage": 1,
"isFirst": true,
"isLast": true,
"pageSize": 10,
"totalCount": 1,
"totalPage": 1,
"allowedClusters": [
{
"clusterName": "tesss",
"brokerNodeType": "2vCPU, 4GB Mem",
"brokerNodeProductName": "vCPU2個、メモリ4GB、[SSD]ディスク50GB",
"brokerNodeCount": 4,
"serverStatus": "running",
"applicationVersion": "Kafka 2.4.0, CMAK 3.0.0.5",
"kafkaVersion": "2.4.0",
"cmakVersion": "3.0.0.5",
"softwareProductName": "CentOS 7.3 (64-bit)",
"createDate": "2020-10-26 11:54:35",
"managerNodeType": "2vCPU, 4GB Mem",
"managerNodeCount": 1,
"clusterPublicDomain": "tesss-1524372151.kr.cdss.beta.naverncp.com",
"isUsePublicDomain": true,
"brokerStorageVolumeSize": 429496729600,
"managerNodeAccessControlGroupSequence": 3751,
"managerNodeAccessControlGroupName": "cdss-m-wd2v",
"brokerNodeAccessControlGroupSequence": 3750,
"brokerNodeAccessControlGroupName": "cdss-b-wd2v",
"kafkaBrokerPort": 9092,
"kafkaBrokerTlsPort": 9093,
"zookeeperPort": 2181,
"cmakPort": 9000,
"serviceGroupInstanceNo": "1509943",
"kafkaManagerUserName": "yea",
"memberNo": "703",
"vpcName": "clean",
"vpcNo": 1236,
"managerNodeSubnetName": "clean-pub |KR-1",
"managerNodeSubnetNo": 1300,
"brokerNodeSubnetName": "clean-private |KR-1",
"brokerNodeSubnetNo": 1301,
"configGroupNo": 127,
"configGroupName": "test-config"
}
],
"disallowedClusters": []
},
"requestId": "e465729c-aff5-4aaf-8981-ed8c87dcd2ca"
}
この記事は役に立ちましたか?