クラスタ ACGリストの照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタの ACGルールリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v2/cluster/getAcgInfoList/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v2/cluster/getAcgInfoList/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v2/cluster/getAcgInfoList/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getAcgInfoList/1037****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.managerNodeAcgRule Object - マネージャノードの ACGルール
result.managerNodeAcgRule.inboundAcgRules Array - Inbound ACGルール: ACGルール情報
result.managerNodeAcgRule.outboundAcgRules Array - Outbound ACGルール: ACGルール情報
result.dataNodeAcgRule Object - データノードの ACGルール
result.dataNodeAcgRule.inboundAcgRules Array - Inbound ACGルール: ACGルール情報
result.dataNodeAcgRule.outboundAcgRules Array - Outbound ACGルール: ACGルール情報
result.masterNodeAcgRule Object - マスターノードの ACGルール
result.masterNodeAcgRule.inboundAcgRules Array - Inbound ACGルール: ACGルール情報
result.masterNodeAcgRule.outboundAcgRules Array - Outbound ACGルール: ACGルール情報
requestId String - リクエスト ID
  • UUID形式

ACGルール情報

ACGルール情報の説明は次の通りです。

フィールド タイプ 必須の有無 説明
accessControlGroupName String - ACG名
accessControlGroupNo Integer - ACG ID
createdYmdt Object - ルールの作成日時
createdYmdt.formattedDate String - ルールの作成日
  • yyyy-MM-dd形式
createdYmdt.formattedDateTime String - ルールの作成日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
createdYmdt.utc Integer - ルールの作成日時(ミリ秒)
  • Unix Timestamp形式
description String - ルールの説明
statusCode String - ルールの状態
accessControlGroupRuleNo Integer - ルール ID
accessControlGroupSequence Integer - アクセスソースの ACG ID
  • Inboundルールのアクセスソースが ACGの場合、有効値を表示
ipBlock String - アクセスソースまたは目的地 IPアドレス
  • アクセスソースまたは目的地が単一の IPアドレスの場合、有効値を表示
isInboundRule Boolean - Inboundルールかどうか
  • true | false
    • true: Inboundルール
    • false: Outboundルール
portRange String - 許可ポート番号
protocolTypeCode String - 許可プロトコル

レスポンスステータスコード

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "managerNodeAcgRule": {
            "inboundAcgRules": [
                {
                    "accessControlGroupName": "searchengine-do-1prxlw",
                    "accessControlGroupNo": 250026,
                    "createdYmdt": {
                        "formattedDate": "2025-03-21",
                        "formattedDateTime": "2025-03-21 10:19:24 000887",
                        "utc": 1742519964887
                    },
                    "description": "(automatically created, don't delete it) for the Search Engine Cluster itself",
                    "statusCode": "RUN",
                    "accessControlGroupRuleNo": 1118600,
                    "accessControlGroupSequence": 250025,
                    "ipBlock": null,
                    "isInboundRule": true,
                    "portRange": "9300",
                    "protocolTypeCode": "tcp"
                },
                ...
            ],
            "outboundAcgRules": [
                {
                    "accessControlGroupName": null,
                    "accessControlGroupNo": 250026,
                    "createdYmdt": {
                        "formattedDate": "2025-03-21",
                        "formattedDateTime": "2025-03-21 10:19:24 000907",
                        "utc": 1742519964907
                    },
                    "description": "automatically created, don't delete it",
                    "statusCode": "RUN",
                    "accessControlGroupRuleNo": 641664,
                    "accessControlGroupSequence": null,
                    "ipBlock": "0.0.0.0/0",
                    "isInboundRule": false,
                    "portRange": null,
                    "protocolTypeCode": "icmp"
                },
                ...
            ]
        },
        "dataNodeAcgRule": {
            "inboundAcgRules": [
                {
                    "accessControlGroupName": "searchengine-do-1prxlw",
                    "accessControlGroupNo": 250025,
                    "createdYmdt": {
                        "formattedDate": "2025-03-21",
                        "formattedDateTime": "2025-03-21 10:19:25 000093",
                        "utc": 1742519965093
                    },
                    "description": "(automatically created, don't delete it) for the Search Engine Cluster itself",
                    "statusCode": "RUN",
                    "accessControlGroupRuleNo": 1118608,
                    "accessControlGroupSequence": 250025,
                    "ipBlock": null,
                    "isInboundRule": true,
                    "portRange": "9300",
                    "protocolTypeCode": "tcp"
                },
                ...
            ],
            "outboundAcgRules": [
                {
                    "accessControlGroupName": null,
                    "accessControlGroupNo": 250025,
                    "createdYmdt": {
                        "formattedDate": "2025-03-21",
                        "formattedDateTime": "2025-03-21 10:19:25 000118",
                        "utc": 1742519965118
                    },
                    "description": "automatically created, don't delete it",
                    "statusCode": "RUN",
                    "accessControlGroupRuleNo": 641670,
                    "accessControlGroupSequence": null,
                    "ipBlock": "0.0.0.0/0",
                    "isInboundRule": false,
                    "portRange": null,
                    "protocolTypeCode": "icmp"
                },
                ...
            ]
        },
        "masterNodeAcgRule": {
            "inboundAcgRules": [
                {
                    "accessControlGroupName": "searchengine-do-1prxlw",
                    "accessControlGroupNo": 250027,
                    "createdYmdt": {
                        "formattedDate": "2025-03-21",
                        "formattedDateTime": "2025-03-21 10:19:24 000981",
                        "utc": 1742519964981
                    },
                    "description": "(automatically created, don't delete it) for the Search Engine Cluster itself",
                    "statusCode": "RUN",
                    "accessControlGroupRuleNo": 1118604,
                    "accessControlGroupSequence": 250025,
                    "ipBlock": null,
                    "isInboundRule": true,
                    "portRange": "9300",
                    "protocolTypeCode": "tcp"
                },
                ...
            ],
            "outboundAcgRules": [
                {
                    "accessControlGroupName": null,
                    "accessControlGroupNo": 250027,
                    "createdYmdt": {
                        "formattedDate": "2025-03-21",
                        "formattedDateTime": "2025-03-21 10:19:25 000002",
                        "utc": 1742519965002
                    },
                    "description": "automatically created, don't delete it",
                    "statusCode": "RUN",
                    "accessControlGroupRuleNo": 641667,
                    "accessControlGroupSequence": null,
                    "ipBlock": "0.0.0.0/0",
                    "isInboundRule": false,
                    "portRange": null,
                    "protocolTypeCode": "icmp"
                },
                ...
            ]
        }
    },
    "requestId": "68739bde-****-****-****-8a775b1a5416"
}