getVpcList
    • PDF

    getVpcList

    • PDF

    記事の要約

    VPC環境で利用できます。

    ユーザーが指定した条件に基づいて VPCリストを検索します。

    リクエスト

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

    メソッドURI
    GET、POST/getVpcList

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    regionCodeStringOptionalVPCリスト照会対象のリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListアクションを通じて確認
  • vpcStatusCodeStringOptionalVPC状態コードで VPCリストを照会
    • INIT | CREATING | RUN | TERMTING
    vpcNameStringOptionalVPC名で VPCリストを照会
    vpcNoList.NList<String>OptionalVPC番号で VPCリストを照会
  • vpcNogetVpcListを通じて確認
  • <例> vpcNoList.1=1234&vpcNoList.2=2345
  • responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcList
    ?regionCode=KR
    &vpcStatusCode=RUN
    &vpcName=test-***
    &vpcNoList.1=***04
    &responseFormatType=xml'
    --header 'x-ncp-apigw-timestamp:: {Timestamp}'    
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'    
    

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <getVpcListResponse>
      <requestId>9b37ea3e-3ca9-462f-abad-6e23a35fcb76</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <vpcList>
        <vpc>
          <vpcNo>***04</vpcNo>
          <vpcName>test-***</vpcName>
          <ipv4CidrBlock>***.***.0.0/16</ipv4CidrBlock>
          <vpcStatus>
            <code>RUN</code>
            <codeName>run</codeName>
          </vpcStatus>
          <regionCode>KR</regionCode>
          <createDate>2020-07-16T22:23:50+0900</createDate>
        </vpc>
      </vpcList>
    </getVpcListResponse>
    

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

    What's Next
    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.