Cloud Data Streaming Service Cluster Get an ACG

Article Summary

Share feedback

Thanks for sharing your feedback!

Can be used in a VPC environment.

Description

Check the Cloud Data Streaming Service Cluster's ACG.

Request

Request URL

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

Request headers

Header	Description
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-key	This is the Access Key ID value issued by the Naver Cloud Platform. `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	This is the signature encrypted Access Key ID value and Secret Key. `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Specifies the request body content type as application/json `Content-Type: application/json`

Request parameters

Parameter	Type	Required status	Description
serviceGroupInstanceNo	String	Y	This is the cluster number to search ACG.

Request example

GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getAcgInfoList/1484848
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

curl -X GET "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getAcgInfoList/1484848" \
-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="

Response parameters

public class GetAcgInfoList {
    GetAccessControlGroupRuleListResponseVo managerNodeAcgRule;
    GetAccessControlGroupRuleListResponseVo dataNodeAcgRule;
}

public class GetAccessControlGroupRuleListResponseVo {
    List<AcgRuleResponseDetailVo> inboundAcgRules;
    List<AcgRuleResponseDetailVo> outboundAcgRules;
}

public class AcgRuleResponseDetailVo {
    Integer accessControlGroupRuleNo;
    Integer accessControlGroupSequence;
    String ipBlock;
    Boolean isInboundRule;
    String portRange;
    String protocolTypeCode;
    String accessControlGroupName;
    Integer accessControlGroupNo;
    DateTimeVo createdYmdt;
    String description;
    String statusCode;
}

public class DateTimeVo {
    Date formattedDate;
    Date formattedDateTime;
    Long utc;
}

Field

Parameter name	Type	Description
managerNodeAcgRule	GetAccessControlGroupRuleListResponseVo	Manager node's ACG rule
brokerNodeAcgRule	GetAccessControlGroupRuleListResponseVo	Broker node's ACG rule
inboundAcgRules	List	Inbound ACG Rule
outboundAcgRules	List	Outbound ACG Rule
accessControlGroupRuleNo	Integer	ACG number
accessControlGroupSequence	Integer	The ACG number of an access source to apply ACG rules
ipBlock	String	The IP of an access source to apply ACG rules
isInboundRule	Boolean	Inbound rule status
portRange	String	It is not used if the port range and port protocol are ICMP.
protocolTypeCode	String	Protocol type
accessControlGroupName	String	ACG name
accessControlGroupNo	Integer	ACG number
createdYmdt	DateTimeVo	ACG creation time
description	String	ACG description
statusCode	String	ACG status
formattedDate	Date	Creation date
formattedDateTime	Date	Creation date and time
utc	Long	Convert the UTC time created into milliseconds

Response example

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "managerNodeAcgRule": {
      "inboundAcgRules": [
        {
          "accessControlGroupName": "cdss-b-wd2v",
          "accessControlGroupNo": 3751,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000476",
            "utc": 1603680876476
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34561,
          "accessControlGroupSequence": 3750,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "22",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3751,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000468",
            "utc": 1603680876468
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34560,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": true,
          "portRange": "9000",
          "protocolTypeCode": "tcp"
        }
      ],
      "outboundAcgRules": [
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3751,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000492",
            "utc": 1603680876492
          },
          "description": "automatically created, don't delete it",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 9203,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": false,
          "portRange": null,
          "protocolTypeCode": "icmp"
        },
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3751,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000489",
            "utc": 1603680876489
          },
          "description": "automatically created, don't delete it",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 9202,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": false,
          "portRange": "1-65535",
          "protocolTypeCode": "udp"
        },
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3751,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000486",
            "utc": 1603680876486
          },
          "description": "automatically created, don't delete it",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 9201,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": false,
          "portRange": "1-65535",
          "protocolTypeCode": "tcp"
        }
      ]
    },
    "brokerNodeAcgRule": {
      "inboundAcgRules": [
        {
          "accessControlGroupName": "cdss-m-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000598",
            "utc": 1603680876598
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34569,
          "accessControlGroupSequence": 3751,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "9999",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-b-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000591",
            "utc": 1603680876591
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34568,
          "accessControlGroupSequence": 3750,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "9093",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-b-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000583",
            "utc": 1603680876583
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34567,
          "accessControlGroupSequence": 3750,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "9092",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-b-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000576",
            "utc": 1603680876576
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34566,
          "accessControlGroupSequence": 3750,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "3888",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-b-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000568",
            "utc": 1603680876568
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34565,
          "accessControlGroupSequence": 3750,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "2888",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-b-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000561",
            "utc": 1603680876561
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34564,
          "accessControlGroupSequence": 3750,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "2181",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-m-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000553",
            "utc": 1603680876553
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34563,
          "accessControlGroupSequence": 3751,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "2181",
          "protocolTypeCode": "tcp"
        },
        {
          "accessControlGroupName": "cdss-m-wd2v",
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000546",
            "utc": 1603680876546
          },
          "description": "(automatically created, don't delete it) for the Cloud Data Streaming Service Cluster itself",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 34562,
          "accessControlGroupSequence": 3751,
          "ipBlock": null,
          "isInboundRule": true,
          "portRange": "22",
          "protocolTypeCode": "tcp"
        }
      ],
      "outboundAcgRules": [
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000611",
            "utc": 1603680876611
          },
          "description": "automatically created, don't delete it",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 9206,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": false,
          "portRange": null,
          "protocolTypeCode": "icmp"
        },
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000609",
            "utc": 1603680876609
          },
          "description": "automatically created, don't delete it",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 9205,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": false,
          "portRange": "1-65535",
          "protocolTypeCode": "udp"
        },
        {
          "accessControlGroupName": null,
          "accessControlGroupNo": 3750,
          "createdYmdt": {
            "formattedDate": "2020-10-26",
            "formattedDateTime": "2020-10-26 11:54:36 000606",
            "utc": 1603680876606
          },
          "description": "automatically created, don't delete it",
          "statusCode": "RUN",
          "accessControlGroupRuleNo": 9204,
          "accessControlGroupSequence": null,
          "ipBlock": "0.0.0.0/0",
          "isInboundRule": false,
          "portRange": "1-65535",
          "protocolTypeCode": "tcp"
        }
      ]
    }
  },
  "requestId": "5e89ebbc-8789-4250-aa74-2d3f8a0da853"
}

Was this article helpful?

What's Next

Check cluster status

Table of contents

Description
Request
Response parameters
Field