setNetworkAclDescription

VPC環境で利用できます。

Network ACL番号を指定して Network ACLの説明を変更します。

リクエスト

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

メソッド	URI
GET \| POST	/vpc/v2/setNetworkAclDescription

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	説明変更対象 Network ACLのリージョンコード照会結果の最初のリージョン(デフォルト) getRegionListを参照
`networkAclNo`	String	Required	説明変更対象の Network ACL番号 getNetworkAclListを参照
`networkAclDescription`	String	Optional	変更対象 Network ACLの説明 (Byte) 0~1000
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/setNetworkAclDescription
?regionCode=KR
&networkAclNo=***31
&networkAclDescription=test-description' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

<setNetworkAclDescriptionResponse>
  <requestId>b3826530-2906-476e-916f-c3f29221c59d</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>test-description</networkAclDescription>
      <createDate>2020-06-24T15:37:07+0900</createDate>
      <isDefault>false</isDefault>
    </networkAcl>
  </networkAclList>
</setNetworkAclDescriptionResponse>