Creating a Cloud Data Streaming Service Cluster (Return ID)
    • PDF

    Creating a Cloud Data Streaming Service Cluster (Return ID)

    • PDF

    Article summary

    Available in VPC

    Description

    How to return serviceGroupInstanceNo after creating a Cloud Sata Streaming Service Cluster

    Requests

    Request URL

    POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/createCDSSClusterReturnServiceGroupInstanceNo [KR]
    POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/createCDSSClusterReturnServiceGroupInstanceNo [SGN]
    POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/createCDSSClusterReturnServiceGroupInstanceNo [JPN]
    

    Request headers

    Header nameDescription
    x-ncp-apigw-timestamp- Time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC
    - Request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyAccess key ID value issued from 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-TypeSet the request body content type to application/json
    Content-Type: application/json

    Request parameters

    ParameterTypeRequirement statusDescription
    clusterNameStringY- Cluster name
    - Only lowercase alphanumeric characters and non-consecutive hyphens (-) allowed
    - First character must be a letter, but the last character may be a letter or a number
    kafkaVersionCodeStringY- Cloud Data Streaming Service version to be used
    Can be obtained via getCDSSVersion action
    kafkaManagerUserNameStringY- CMAK access ID
    - Only lowercase alphanumeric characters and non-consecutive hyphens (-) allowed
    First character must be a letter, but the last character may be a letter or a number
    kafkaManagerUserPasswordStringY- CMAK access password
    - Must be at least 8 characters and contain at least one of each: English uppercase letter, lowercase letter, special character, and number
    softwareProductCodeStringY- OS type to be used
    - Can be obtained via getOsProductList action
    vpcNoIntegerY- VPC number to be used
    - Can be obtained via getVpcList action
    managerNodeProductCodeStringY- HW specifications of the manager node
    - Can be obtained via getNodeProductList action
    managerNodeSubnetNoIntegerY- Subnet number where the manager node is to be located
    - Can be obtained via getSubnetList action
    brokerNodeProductCodeStringY- HW specifications of the broker node
    - Can be obtained via getNodeProductList action
    brokerNodeSubnetNoIntegerY- Subnet number where the broker node is to be located
    - Can be obtained via getSubnetList action
    brokerNodeCountIntegerY- Number of broker nodes
    - At least 3 units, up to 10 units allowed
    brokerNodeStorageSizeIntegerY- Broker node storage capacity
    - At least 100 GB, up to 2000 GB. Must be in units of 10 GB
    configGroupNoIntegerY- ConfigGroup number to be used
    - Can be obtained via getKafkaVersionConfigGroupList action

    Request examples

    POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/createCDSSClusterReturnServiceGroupInstanceNo
    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
    
    {
      "clusterName": "test",
      "kafkaVersionCode": "2403005",
      "kafkaManagerUserName": "test",
      "kafkaManagerUserPassword": "qwe123!@#",
      "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
      "vpcNo": 1236,
      "managerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
      "managerNodeSubnetNo": 1300,
      "brokerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
      "brokerNodeCount": 3,
      "brokerNodeSubnetNo": 1301,
      "brokerNodeStorageSize": 100,
      "configGroupNo": 127
    }
    
    curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/createCDSSClusterReturnServiceGroupInstanceNo" \
    -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 \
    '{
       "clusterName": "test",
       "kafkaVersionCode": "2403005",
       "kafkaManagerUserName": "test",
       "kafkaManagerUserPassword": "qwe123!@#",
       "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
       "vpcNo": 1236,
       "managerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
       "managerNodeSubnetNo": 1300,
       "brokerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
       "brokerNodeCount": 3,
       "brokerNodeSubnetNo": 1301,
       "brokerNodeStorageSize": 100,
       "configGroupNo": 127
     }'
    

    Response parameters

    public class CreateClusterResponseVo {
        Integer serviceGroupInstanceNo;
    }
    

    Field

    ParameterTypeDescription
    serviceGroupInstanceNoIntegerUnique identifier for created cluster

    Response examples

    {
      "code": 0,
      "message": "SUCCESS",
      "result": {
        "serviceGroupInstanceNo": 2435417
      },
      "requestId": "179bf48d-34e7-4a04-ba8c-1d51dee9abef"
    }
    

    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.