getPublicIpInstanceList
    • PDF

    getPublicIpInstanceList

    • PDF

    記事の要約

    概要

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

    リクエスト

    リクエストパラメータ

    パラメータ名必須の有無タイプ制限事項説明
    isAssociatedNoBoolean- 割り当ての有無
    割り当てられたグローバル IPアドレス、割り当てられていないグローバル IPアドレスを照会できる
    オプション: true | false
    publicIpInstanceNoList.NNoString重複不可- 照会対象グローバル IPアドレスのインスタンス番号リスト
    例) publicIpInstanceNoList.1=937520&publicIpInstanceNoList.2=932956
    publicIpList.NNoList<String>最小: 5, 最大: 15- 照会対象のグローバル IPアドレス
    例) publicIpList.1=106.10.53.67
    searchFilterNameNoString- 検索時に適用するフィルタ名
    グローバル IPアドレス(publicIp)と割り当てられたサーバ名(associatedServerName)で絞り込み検索
    オプション: publicIp | associatedServerName [大文字小文字を区別しない]
    searchFilterNameは以下の searchFilterValue値と mappingして使用
    例: searchFilterName=publicIp&searchFilterValue=106.10.53.67
    例) searchFilterName=associatedServerName&searchFilterValue=s1669aa4e78c
    searchFilterValueNoString- 検索時に適用するフィルタの値
    上記の searchFilterName値と mappingする値を入力
    regionNoNoString- リージョン番号
    グローバル IPアドレスのインスタンスリストを、リージョン(Region)を使用して絞り込みできる
    regionNoは getRegionListアクションを通じて取得可能
    zoneNoNoString- ZONE番号
    グローバル IPアドレスのインスタンスリストを、ゾーン(zone)を使用して絞り込みできる
    zoneNoは getZoneListアクションを通じて取得可能
    フィルタが設定されていない場合は、そのリージョン(Region)のゾーン(zone)に属するグローバル IPアドレスリストが全選択される
    pageNoNoInteger最小: 0,
    最大: 2147483647
    - ページングされた結果のページ番号
    結果値は pageNoを利用してページング処理できる
    pageSizeNoInteger最小: 0,
    最大: 2147483647
    - ページング時に表示する各ページサイズ
    結果値は pageSizeを利用してページング処理できる
    sortedByNoString- ソート対象
    グローバル IPアドレスとグローバル IPアドレスインスタンス番号でソート
    オプション: publicIp (グローバル IPアドレス) | publicIpInstanceNo (グローバル IPアドレスのインスタンス番号) [大文字小文字を区別しない]
    デフォルト: publicIpInstanceNo
    sortedByは、以下の sortingOrderと mappingして使用
    例: sortedBy=publicIp&sortingOrder=ascending
    例) sortedBy=publicIpInstanceNo&sortingOrder=descending
    sortingOrderNoString- ソート順序
    上記で設定した SortedByの昇順/降順ソート設定
    ascending(昇順) | descending(降順) [大文字小文字を区別しない]
    デフォルト: ascending
    responseFormatTypeNoString- レスポンス結果の形式タイプ
    オプション: xml | json
    デフォルト: xml

    レスポンス

    レスポンスボディ

    リクエスト例

    GET {SERVER_API_URL}/getPublicIpInstanceList
    ?searchFilterName=associatedServerName
    &searchFilterValue=s1669aa4e78c
    

    レスポンス例

    <getPublicIpInstanceListResponse>
      <requestId>9e27266d-049c-42c7-a04a-a884290dddb1</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <publicIpInstanceList>
        <publicIpInstance>
          <publicIpInstanceNo>1081432</publicIpInstanceNo>
          <publicIp>106.10.46.237</publicIp>
          <publicIpDescription></publicIpDescription>
          <createDate>2018-11-23T18:33:45+0900</createDate>
          <publicIpInstanceStatusName>used</publicIpInstanceStatusName>
          <publicIpInstanceStatus>
            <code>USED</code>
            <codeName>NET USED state</codeName>
          </publicIpInstanceStatus>
          <publicIpInstanceOperation>
            <code>NULL</code>
            <codeName>NET NULL OP</codeName>
          </publicIpInstanceOperation>
          <publicIpKindType>
            <code>GEN</code>
            <codeName>General</codeName>
          </publicIpKindType>
          <serverInstanceAssociatedWithPublicIp>
            <serverInstanceNo>1021003</serverInstanceNo>
            <serverName>s1669aa4e78c</serverName>
            <serverDescription>マイサーバイメージコピーエラーテスト</serverDescription>
            <cpuCount>2</cpuCount>
            <memorySize>4294967296</memorySize>
            <baseBlockStorageSize>53687091200</baseBlockStorageSize>
            <platformType>
              <code>LNX64</code>
              <codeName>Linux 64 Bit</codeName>
            </platformType>
            <loginKeyName>juhoon-kim</loginKeyName>
            <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
            <publicIp>106.10.46.237</publicIp>
            <privateIp>10.41.3.81</privateIp>
            <serverImageName>tensorflow-centos-7.3-64</serverImageName>
            <serverInstanceStatus>
              <code>NSTOP</code>
              <codeName>Server normal stopped state</codeName>
            </serverInstanceStatus>
            <serverInstanceOperation>
              <code>NULL</code>
              <codeName>Server NULL OP</codeName>
            </serverInstanceOperation>
            <serverInstanceStatusName>stopped</serverInstanceStatusName>
            <createDate>2018-10-22T16:19:50+0900</createDate>
            <uptime>2018-11-23T17:38:44+0900</uptime>
            <serverImageProductCode>SPSW0LINUX000066</serverImageProductCode>
            <serverProductCode>SPSVRSSD00000003</serverProductCode>
            <isProtectServerTermination>false</isProtectServerTermination>
            <portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
            <zone>
              <zoneNo>3</zoneNo>
              <zoneName>KR-2</zoneName>
              <zoneCode>KR-2</zoneCode>
              <zoneDescription>坪村ゾーン</zoneDescription>
              <regionNo>1</regionNo>
            </zone>
            <region>
              <regionNo>1</regionNo>
              <regionCode>KR</regionCode>
              <regionName>Korea</regionName>
            </region>
            <baseBlockStorageDiskType>
              <code>NET</code>
              <codeName>Network Storage</codeName>
            </baseBlockStorageDiskType>
            <baseBlockStorageDiskDetailType>
              <code>SSD</code>
              <codeName>SSD</codeName>
            </baseBlockStorageDiskDetailType>
            <serverInstanceType>
              <code>STAND</code>
              <codeName>Standard</codeName>
            </serverInstanceType>
            <userData></userData>
            <accessControlGroupList>
              <accessControlGroup>
                <accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
                <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                <isDefault>true</isDefault>
                <createDate>2018-04-09T11:12:54+0900</createDate>
              </accessControlGroup>
            </accessControlGroupList>
            <instanceTagList/>
          </serverInstanceAssociatedWithPublicIp>
          <zone>
            <zoneNo>3</zoneNo>
            <zoneName>KR-2</zoneName>
            <zoneCode>KR-2</zoneCode>
            <zoneDescription>坪村ゾーン</zoneDescription>
            <regionNo>1</regionNo>
          </zone>
        </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.