getPublicIpInstanceList
    • PDF

    getPublicIpInstanceList

    • PDF

    Article Summary

    VPC環境で利用できます。

    概要

    グローバルIPインスタンスリストを照会します。

    リクエスト

    リクエストパラメータ

    パラメータ名必須の有無タイプ制約事項説明
    regionCodeNoStringリージョンコード
    グローバルIPインスタンスのリストが照会されるリージョン(Region)を決定できます。
    regionCodeはgetRegionListアクションを通じて取得できます。
    Default:getRegionList照会結果の最初のリージョンを選択
    publicIpInstanceNoList.NNoList<String>グローバルIPインスタンス番号リスト
    グローバルIPインスタンス番号でフィルタリングして検索できます。
    publicIpInstanceNoはgetPublicIpInstanceListアクションを通じて取得できます。
    ex) publicIpInstanceNoList.1=1234&publicIpInstanceNoList.2=2345
    publicIpNoStringグローバルIPアドレス
    グローバルIPアドレスでフィルタリングして検索できます。
    privateIpNoStringプライベートIPアドレス
    グローバルIPインスタンスが割り当てられたサーバインスタンスのeth0プライベートIPアドレスでフィルタリングして検索できます。
    isAssociatedNoBoolean割り当ての有無
    サーバインスタンスに割り当てられたグローバルIPと割り当てられていないグローバルIPでフィルタリングして検索できます。
    Options : true | false
    serverNameNoStringサーバ名
    グローバルIPインスタンスが割り当てられたサーバ名でフィルタリングして検索できます。
    publicIpInstanceStatusCodeNoStringグローバルIPインスタンスのステータスコード
    グローバルIPインスタンスのステータスコードでフィルタリングして検索できます。
    Options : INIT | SET | RUN | TERMTING
    pageNoNoIntegerページングされた結果のページ番号
    結果値をpageNo、pageSizeを利用してページング処理できます。
    pageSizeConditionalIntegerページングする時に表示する各ページサイズ
    結果値をpageNo、pageSizeを利用してページング処理できます。
    pageNoを入力する時、必ず入力しなければなりません。
    vpcNoNoStringVPC番号
    VPC番号でフィルタリングして検索できます。
    vpcNoはgetVpcListアクションを通じて取得できます。
    responseFormatTypeNoStringレスポンス結果のフォーマットタイプ
    Options : xml | json
    Default : xml

    レスポンス

    レスポンスボディ

    リクエスト例

    GET {API_URL}/getPublicIpInstanceList
    ?regionCode=KR
    &publicIpInstanceNoList.1=***7551
    &publicIp=***.***.111.215
    &privateIp=***.***.1.6
    &isAssociated=true
    &serverName=test-***
    &publicIpInstanceStatusCode=RUN
    &vpcNo=***04
    

    レスポンス例

    <getPublicIpInstanceListResponse>
      <requestId>ff28f839-00f2-4d07-bd6b-b172596eebf8</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <publicIpInstanceList>
        <publicIpInstance>
          <publicIpInstanceNo>***7551</publicIpInstanceNo>
          <publicIp>***.***.111.215</publicIp>
          <publicIpDescription></publicIpDescription>
          <createDate>2020-08-19T14:34:41+0900</createDate>
          <publicIpInstanceStatusName>運用中</publicIpInstanceStatusName>
          <publicIpInstanceStatus>
            <code>RUN</code>
            <codeName>run</codeName>
          </publicIpInstanceStatus>
          <serverInstanceNo>***4299</serverInstanceNo>
          <serverName>test-***</serverName>
          <privateIp>***.***.1.6</privateIp>
          <publicIpInstanceOperation>
            <code>NULL</code>
            <codeName>NULL OP</codeName>
          </publicIpInstanceOperation>
        </publicIpInstance>
      </publicIpInstanceList>
    </getPublicIpInstanceListResponse>
    

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

    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.