setVpcPeeringDescription

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Overview

Modify the VPC peering description.

Request

Request parameter

Parameter Name	Required Status	Type	Restrictions	Description
regionCode	No	String		Region Code You can decide the region of the VPC Peering instance whose description will be modified. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results.
vpcPeeringInstanceNo	Yes	String		The number of the VPC Peering instance whose description will be modified vpcPeeringInstanceNo can be obtained through the getVpcPeeringInstanceList action.
vpcPeeringDescription	No	String	Min : 0, Max : 1000 Bytes	The VPC Peering instance description to be modified
responseFormatType	No	String		Format type for the response result Options : xml \| json Default : xml

Response

Response data type

VpcPeeringInstanceList type

VpcPeeringInstanceList extends CommonResponse
private Integer totalRows;
private List vpcPeeringInstanceList = new ArrayList<>();

VpcPeeringInstance
private String vpcPeeringInstanceNo;
private String vpcPeeringName;
private String regionCode;
private Date createDate;
private Date lastModifyDate;
private CommonCode vpcPeeringInstanceStatus;
private String vpcPeeringInstanceStatusName;
private CommonCode vpcPeeringInstanceOperation;
private String sourceVpcNo;
private String sourceVpcName;
private String sourceVpcIpv4CidrBlock;
private String sourceVpcLoginId;
private String targetVpcNo;
private String targetVpcName;
private String targetVpcIpv4CidrBlock;
private String targetVpcLoginId;
private String vpcPeeringDescription;
private Boolean hasReverseVpcPeering;
private Boolean isBetweenAccounts;
private String reverseVpcPeeringInstanceNo;

Example

Request example

ncloud vpc setVpcPeeringDescription --regionCode KR --vpcPeeringInstanceNo ***6212 --vpcPeeringDescription test-description

Response example

<setVpcPeeringDescriptionResponse>
  <requestId>714c5071-50d0-48ea-8e4f-e449009036d2</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <vpcPeeringInstanceList>
    <vpcPeeringInstance>
      <vpcPeeringInstanceNo>***6212</vpcPeeringInstanceNo>
      <vpcPeeringName>test-***</vpcPeeringName>
      <regionCode>KR</regionCode>
      <createDate>2020-08-04T14:57:08+0900</createDate>
      <vpcPeeringInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </vpcPeeringInstanceStatus>
      <vpcPeeringInstanceStatusName>Running</vpcPeeringInstanceStatusName>
      <vpcPeeringInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </vpcPeeringInstanceOperation>
      <sourceVpcNo>***05</sourceVpcNo>
      <sourceVpcName>test-***</sourceVpcName>
      <sourceVpcIpv4CidrBlock>***.**1.0.0/16</sourceVpcIpv4CidrBlock>
      <sourceVpcLoginId>test-***@naver.com</sourceVpcLoginId>
      <targetVpcNo>***06</targetVpcNo>
      <targetVpcName>test-***</targetVpcName>
      <targetVpcIpv4CidrBlock>***.**2.0.0/16</targetVpcIpv4CidrBlock>
      <targetVpcLoginId>test-***@naver.com</targetVpcLoginId>
      <vpcPeeringDescription>test-description</vpcPeeringDescription>
      <hasReverseVpcPeering>false</hasReverseVpcPeering>
      <isBetweenAccounts>false</isBetweenAccounts>
      <reverseVpcPeeringInstanceNo></reverseVpcPeeringInstanceNo>
    </vpcPeeringInstance>
  </vpcPeeringInstanceList>
</setVpcPeeringDescriptionResponse>

Was this article helpful?

What's Next

getRouteTableList

Table of contents

Overview
Request
Response
Example