Get Search Engine Cluster ACG
- Print
- PDF
Get Search Engine Cluster ACG
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Description
Check the Search Engine Cluster's ACG.
Request
Request URL
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getAcgInfoList/{service-group-instance-no} [KR]
GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getAcgInfoList/{service-group-instance-no} [SGN]
GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/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 portal.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/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | This is the cluster no. to search ACG. |
Request example
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getAcgInfoList/1484848
HOST: vpcsearchengine.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://vpcsearchengine.apigw.ntruss.com/api/v2/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;
GetAccessControlGroupRuleListResponseVo masterNodeAcgRule;
}
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 {
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "Asia/Seoul")
Date formattedDate;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss SSSSSS", timezone = "Asia/Seoul")
Date formattedDateTime;
Long utc;
}
Field
| Parameter Name | Type | Description |
|---|---|---|
| managerNodeAcgRule | GetAccessControlGroupRuleListResponseVo | ACG rule of the manager node |
| dataNodeAcgRule | GetAccessControlGroupRuleListResponseVo | ACG rule of the data node |
| masterNodeAcgRule | GetAccessControlGroupRuleListResponseVo | ACG rule of the master node |
| inboundAcgRules | List<AcgRuleResponseDetailVo> | Inbound ACG Rule |
| outboundAcgRules | List<AcgRuleResponseDetailVo> | Outbound ACG Rule |
| accessControlGroupRuleNo | Integer | ACG no. |
| accessControlGroupSequence | Integer | The ACG no. of an access source to apply ACG rule |
| ipBlock | String | The IP of an access source to apply ACG rule |
| isInboundRule | Boolean | Whether it's the inbound rule |
| 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 no. |
| 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": "searchengine-m-vtps",
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000571",
"utc": 1601975200571
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118617,
"accessControlGroupSequence": 62222,
"ipBlock": null,
"isInboundRule": true,
"portRange": "22",
"protocolTypeCode": "tcp"
},
{
"accessControlGroupName": "searchengine-d-vtps",
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000559",
"utc": 1601975200559
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118616,
"accessControlGroupSequence": 62221,
"ipBlock": null,
"isInboundRule": true,
"portRange": "9300",
"protocolTypeCode": "tcp"
},
{
"accessControlGroupName": "searchengine-m-vtps",
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000547",
"utc": 1601975200547
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118615,
"accessControlGroupSequence": 62222,
"ipBlock": null,
"isInboundRule": true,
"portRange": "9300",
"protocolTypeCode": "tcp"
},
{
"accessControlGroupName": null,
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000535",
"utc": 1601975200535
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118614,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": true,
"portRange": "80",
"protocolTypeCode": "tcp"
}
],
"outboundAcgRules": [
{
"accessControlGroupName": null,
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000583",
"utc": 1601975200583
},
"description": "automatically created, don't delete it",
"statusCode": "RUN",
"accessControlGroupRuleNo": 32871,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": false,
"portRange": null,
"protocolTypeCode": "icmp"
},
{
"accessControlGroupName": null,
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000581",
"utc": 1601975200581
},
"description": "automatically created, don't delete it",
"statusCode": "RUN",
"accessControlGroupRuleNo": 32870,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": false,
"portRange": "1-65535",
"protocolTypeCode": "udp"
},
{
"accessControlGroupName": null,
"accessControlGroupNo": 62222,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000579",
"utc": 1601975200579
},
"description": "automatically created, don't delete it",
"statusCode": "RUN",
"accessControlGroupRuleNo": 32869,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": false,
"portRange": "1-65535",
"protocolTypeCode": "tcp"
}
]
},
"dataNodeAcgRule": {
"inboundAcgRules": [
{
"accessControlGroupName": "searchengine-d-vtps",
"accessControlGroupNo": 62221,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000658",
"utc": 1601975200658
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118620,
"accessControlGroupSequence": 62221,
"ipBlock": null,
"isInboundRule": true,
"portRange": "9300",
"protocolTypeCode": "tcp"
},
{
"accessControlGroupName": "searchengine-m-vtps",
"accessControlGroupNo": 62221,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000646",
"utc": 1601975200646
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118619,
"accessControlGroupSequence": 62222,
"ipBlock": null,
"isInboundRule": true,
"portRange": "9300",
"protocolTypeCode": "tcp"
},
{
"accessControlGroupName": "searchengine-m-vtps",
"accessControlGroupNo": 62221,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000634",
"utc": 1601975200634
},
"description": "(automatically created, don't delete it) for the Elasticsearch Cluster itself",
"statusCode": "RUN",
"accessControlGroupRuleNo": 118618,
"accessControlGroupSequence": 62222,
"ipBlock": null,
"isInboundRule": true,
"portRange": "22",
"protocolTypeCode": "tcp"
}
],
"outboundAcgRules": [
{
"accessControlGroupName": null,
"accessControlGroupNo": 62221,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000668",
"utc": 1601975200668
},
"description": "automatically created, don't delete it",
"statusCode": "RUN",
"accessControlGroupRuleNo": 32874,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": false,
"portRange": null,
"protocolTypeCode": "icmp"
},
{
"accessControlGroupName": null,
"accessControlGroupNo": 62221,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000666",
"utc": 1601975200666
},
"description": "automatically created, don't delete it",
"statusCode": "RUN",
"accessControlGroupRuleNo": 32873,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": false,
"portRange": "1-65535",
"protocolTypeCode": "udp"
},
{
"accessControlGroupName": null,
"accessControlGroupNo": 62221,
"createdYmdt": {
"formattedDate": "2020-10-06",
"formattedDateTime": "2020-10-06 18:06:40 000664",
"utc": 1601975200664
},
"description": "automatically created, don't delete it",
"statusCode": "RUN",
"accessControlGroupRuleNo": 32872,
"accessControlGroupSequence": null,
"ipBlock": "0.0.0.0/0",
"isInboundRule": false,
"portRange": "1-65535",
"protocolTypeCode": "tcp"
}
]
},
"masterNodeAcgRule": null
},
"requestId": "97d3fafd-a270-4bc3-8f7e-ecad1fb80487"
}
Was this article helpful?