setVpcPeeringDescription
    • PDF

    setVpcPeeringDescription

    • PDF

    記事の要約

    VPC環境で利用できます。

    VPC Peeringインスタンスの番号を指定して VPC Peeringの説明を変更します。

    リクエスト

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

    メソッドURI
    GET、POST/setVpcPeeringDescription

    リクエストヘッダ

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

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

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    regionCodeStringOptional説明を変更する対象の VPC Peeringインスタンスのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
  • vpcPeeringInstanceNoStringRequired説明を変更する対象の VPC Peeringインスタンス番号
  • getVpcPeeringInstanceListを通じて確認
  • vpcPeeringDescriptionStringOptional変更後の VPC Peeringの説明 (Byte)
  • 0~1000
  • responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/setVpcPeeringDescription
    ?regionCode=KR
    &vpcPeeringInstanceNo=***6212
    &vpcPeeringDescription=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}'
    

    レスポンス

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

    レスポンスボディ

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

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

    NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

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

    <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>
          <lastModifyDate>2020-08-04T14:57:08+0900</lastModifyDate>
          <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>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.