Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

setVpcPeeringDescription

Prev Next

VPC環境で利用できます。

概要

VPC Peeringの説明を修正します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
説明を修正するVPC Peeringインスタンスのリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default:getRegionList照会結果の最初のリージョンを選択
vpcPeeringInstanceNo Yes String 説明を修正するVPC Peeringインスタンス番号
vpcPeeringInstanceNoはgetVpcPeeringInstanceListアクションを通じて取得できます。
vpcPeeringDescription No String Min : 0, Max : 1000 Bytes 修正するVPC Peeringに関する説明
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータタイプ

  • VpcPeeringInstanceListタイプ
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;

リクエスト例

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

レスポンス例

<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>運用中</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>