MENU
      Search single Cloud Data Streaming Service cluster

        Search single Cloud Data Streaming Service cluster


        Article summary

        It is available in a VPC environment.

        Description

        Searches the cluster that exists in Cloud Data Streaming Service.

        Request

        Request URL

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/{service-group-instance-no} [KR]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getClusterInfoList/{service-group-instance-no} [SGN]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getClusterInfoList/{service-group-instance-no} [JPN]
        HTTP

        Request header

        Header nameDescription
        x-ncp-apigw-timestamp- This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
        - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyValue of access key ID issued in the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecifies the request body content type as application/json
        Content-Type: application/json

        Request parameter

        ParameterTypeRequirement statusDescription
        serviceGroupInstanceNoStringYNumber of cluster whose list of broker nodes is searched

        Request examples

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/2434156
        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
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/2434156 \
        -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=" \
        Bash

        Response parameter

        public class GetClusterInfoResponseVo {
            String clusterName;
            String kafkaVersionCode;
            String kafkaManagerUserName;
            String softwareProductCode;
            Integer vpcNo;
            String managerNodeProductCode;
            Integer managerNodeSubnetNo;
            String brokerNodeProductCode;
            Integer brokerNodeSubnetNo;
            Integer brokerNodeCount;
            Long brokerNodeStorageSize;
            Integer configGroupNo;
            String status;
        }
        Java

        Field

        Parameter nameTypeDescription
        clusterNameStringCluster name
        kafkaVersionCodeStringKafka version code
        kafkaManagerUserNameStringCMAK access ID
        softwareProductCodeStringOS type being used
        vpcNoIntegerNumber of the VPC where the server is located
        managerNodeProductCodeStringHW specifications of the manager node
        managerNodeSubnetNoIntegerNumber of the subnet where the manager node is located
        brokerNodeProductCodeStringHW specifications of the broker node
        brokerNodeSubnetNoIntegerName of the subnet where the broker node is located
        brokerNodeCountIntegerNumber of broker nodes
        brokerNodeStorageSizeIntegerBroker node storage capacity
        conifgGroupNoIntegerNumber of ConfigGroup
        statusStringCurrent cluster status

        Response examples

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "clusterName": "for-swagger",
            "kafkaVersionCode": "2403005",
            "kafkaManagerUserName": "string",
            "kafkaManagerUserPassword": "jeuJTgm5c6sYDlAcRrMf1A==",
            "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
            "vpcNo": 3438,
            "managerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
            "managerNodeSubnetNo": 5573,
            "brokerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
            "brokerNodeSubnetNo": 4853,
            "brokerNodeCount": 3,
            "brokerNodeStorageSize": 100,
            "configGroupNo": 127,
            "status": "running"
          },
          "requestId": "6ab5082c-b672-411f-9174-877a658d0148"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.