getAccessControlGroupList

Prev Next

Can be used in a VPC environment.

Overview

Query the ACG list. ACGs can be configured on the network interface and function as access control.

Request

Request parameter

Parameter Name Required Status Type Restrictions Description
regionCode No String Region Code
You can decide the region where the ACG list will be queried.
The regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList query results.
vpcNo No String VPC number
You can search by filtering with the VPC number.
vpcNo can be obtained through the getVpcList action.
accessControlGroupNoList.N No List<String> List of ACG numbers
You can search by filtering with the ACG number.
The accessControlGroupNo can be obtained through the getAccessControlGroupList action.
ex) accessControlGroupNoList 1234 2345
accessControlGroupName No String ACG name
You can search by filtering with an ACG name.
accessControlGroupStatusCode No String ACG status code
You can search by filtering with the ACG status code.
Options : INIT | SET | RUN | TERMTING
pageNo No Integer The page number of the paged results
The results can shown as pages using pageNo and pageSize.
pageSize Conditional Integer The size of each page to be displayed at the time of paging
The results can shown as pages using pageNo and pageSize.
Enter it when entering pageNo.
responseFormatType No String Format type for the response result
Options : xml | json
Default : xml

Response

Response data type

  • AccessControlGroupList type
AccessControlGroupList extends CommonResponse
private Integer totalRows;
private List<AccessControlGroup> accessControlGroupList = new ArrayList<>();
AccessControlGroup
private String accessControlGroupNo;
private String accessControlGroupName;
private Boolean isDefault;
private String vpcNo;
private CommonCode accessControlGroupStatus;
private String accessControlGroupDescription;

Example

Request example

ncloud vserver getAccessControlGroupList --regionCode KR --vpcNo ***04 --accessControlGroupNoList ***63 ***64 --accessControlGroupName test-*** --accessControlGroupStatusCode RUN

Response example

<getAccessControlGroupListResponse>
  <requestId>aca35644-739e-42b3-bdcb-55c2eedc54b9</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <accessControlGroupList>
    <accessControlGroup>
      <accessControlGroupNo>***63</accessControlGroupNo>
      <accessControlGroupName>test-***</accessControlGroupName>
      <isDefault>false</isDefault>
      <vpcNo>***04</vpcNo>
      <accessControlGroupStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </accessControlGroupStatus>
      <accessControlGroupDescription></accessControlGroupDescription>
    </accessControlGroup>
  </accessControlGroupList>
</getAccessControlGroupListResponse>