getNetworkAclList

Prev Next

VPC環境で利用できます。

ユーザーが指定した条件に基づいて Network ACLリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vpc/v2/getNetworkAclList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional Network ACLリスト照会対象のリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを参照
networkAclName String Optional Network ACL名でリストを照会
networkAclStatusCode String Optional Network ACLの状態コードでリストを照会
  • INIT | SET | RUN | TERMTING
networkAclNoList.N List[String] Optional Network ACL番号でリストを照会
  • networkAclNogetNetworkAclListを参照
  • <例> networkAclNoList.1=1234&networkAclNoList.2=2345
pageNo Integer Optional ページングされた結果のページ番号
  • pageNopageSizeを利用して結果値をページング処理
pageSize Integer Conditional ページング時に表示する各ページのサイズ
  • pageNo入力時、必須
  • pageNopageSizeを利用して結果値をページング処理
vpcNo String Optional VPC番号でリストを照会
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getNetworkAclList
?regionCode=KR
&networkAclName=test-***
&networkAclStatusCode=RUN
&networkAclNoList.1=***31
&vpcNo=***04' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、NetworkAclListをご参照ください。

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

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

レスポンス例

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

<getNetworkAclListResponse>
  <requestId>dc9325b1-a000-4db5-ac28-e33819b910eb</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <networkAclList>
    <networkAcl>
      <networkAclNo>***31</networkAclNo>
      <networkAclName>test-***</networkAclName>
      <vpcNo>***04</vpcNo>
      <networkAclStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </networkAclStatus>
      <networkAclDescription></networkAclDescription>
      <createDate>2020-07-31T14:29:14+0900</createDate>
      <isDefault>false</isDefault>
    </networkAcl>
  </networkAclList>
</getNetworkAclListResponse>