getAccessControlGroupDetail

Prev Next

VPC環境で利用できます。

ACGの詳細情報を照会します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/getAccessControlGroupDetail
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
accessControlGroupNo String Required ACG番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getAccessControlGroupDetail
?regionCode=KR
&accessControlGroupNo=1***1
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
getAccessControlGroupDetailResponse Object - レスポンス結果
getAccessControlGroupDetailResponse.requestId String - リクエスト ID
  • UUID形式
getAccessControlGroupDetailResponse.returnCode String - レスポンスコード
getAccessControlGroupDetailResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
  "getAccessControlGroupDetailResponse": {
    "totalRows": 1,
    "accessControlGroupList": [
      {
        "accessControlGroupNo": "1***1",
        "accessControlGroupName": "test-vpc2-default-acg",
        "isDefault": true,
        "vpcNo": "4**5",
        "accessControlGroupStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "accessControlGroupDescription": "VPC [test-vpc2] default ACG"
      }
    ],
    "requestId": "1e0e9734-****-****-****-31a64dc71cdf",
    "returnCode": "0",
    "returnMessage": "success"
  }
}