setNatGatewayDescription

개요

NAT Gateway 설명을 수정합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String 리전 코드
설명을 수정할 NAT Gateway 인스턴스의 리전(Region)을 결정할 수 있습니다.
regionCode는 getRegionList 액션을 통해서 획득할 수 있습니다.
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
natGatewayInstanceNo Yes String 설명을 수정할 NAT Gateway 인스턴스 번호
natGatewayInstanceNo는 getNatGatewayInstanceList 액션을 통해서 획득할 수 있습니다.
natGatewayDescription No String Min : 0, Max : 1000 Bytes 수정할 NAT Gateway에 대한 설명
responseFormatType No String 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 바디

예시

요청 예시

GET {API_URL}/vpc/v2/setNatGatewayDescription
?regionCode=KR
&natGatewayInstanceNo=***38
&natGatewayDescription=test-description

응답 예시

<setNatGatewayDescriptionResponse>
  <requestId>bbe69135-359f-443a-8a32-d38d590e2c87</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***04</vpcNo>
      <vpcName>test-***</vpcName>
      <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
      <natGatewayName>test-***</natGatewayName>
      <publicIp>***.***.109.101</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>운영중</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2020-06-24T08:58:20+0900</createDate>
      <natGatewayDescription>test-description</natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
    </natGatewayInstance>
  </natGatewayInstanceList>
</setNatGatewayDescriptionResponse>