MENU
      Cloud Data Streaming Service

        Cloud Data Streaming Service


        Article summary

        Available in Classic and VPC

        Get the list of Cloud Data Streaming Service server instances (VMs) in the VPC environment.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/api/{regionCode}-v1/vpc/servers/cdss

        Request headers

        For information about the headers common to all Cloud Log Analytics APIs, see Cloud Log Analytics request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        regionCodeStringRequiredRegion code
        • kr | sgn | jpn
          • kr: Korea Region
          • sgn: Singapore Region
          • jpn: Japan Region

        Request query parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        pageNoIntegerOptionalPage number
        • 1 - 100 (default: 1)
        pageSizeIntegerOptionalNumber of items per page
        • 20 - 100 (default: 20)

        Request example

        The request example is as follows:

        curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/vpc/servers/cdss' \
        --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' \
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        codeInteger-Response status codes
        messageString-Response status message
        resultObject-Response result
        result.pageSizeInteger-Number of items per page
        result.currentPageInteger-Current page number
        result.totalPageInteger-Total number of pages
        result.totalCountInteger-Total item count
        result.isPagedBoolean-Whether to page
        • true | false
          • true: paged
          • false: not paged
        result.clusterInfoListArray-Server list
        • Server information
        Note

        For more information about the fields related to server information (clusterInfoList), see the Cloud Data Streaming Service API Guide and Cloud Data Streaming Service User Guide.

        Response status codes

        For response status codes common to all Cloud Log Analytics APIs, see Cloud Log Analytics response status codes.

        Response example

        The response example is as follows:

        {
            "code": 0,
            "message": "The request has been successfully processed.",
            "result": {
                "pageSize": 10,
                "currentPage": 1,
                "totalPage": 1,
                "totalCount": 1,
                "isPaged": true,
                "clusterInfoList": [
                    {
                        "clusterName": "cdss-test",
                        "serverStatus": "In operation",
                        "serverStatusColor": "green",
                        "kafkaVersion": "3.7.1",
                        "vpcName": "test"
                    }
                ]
            }
        }
        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.