getPublicIpInstanceList
- 印刷する
- PDF
getPublicIpInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
グローバルIPインスタンスリストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| isAssociated | No | Boolean | 割り当て区分 割り当てられているグローバルIP、割り当てられてないグローバルIPを照会できます。 Options : true | false | |
| publicIpInstanceNoList.N | No | String | 重複不可 | 照会するグローバルIPインスタンス番号リスト ex) publicIpInstanceNoList.1=937520&publicIpInstanceNoList.2=932956 |
| publicIpList.N | No | List<String> | Min : 5, Max : 15 | 照会するグローバルIPリスト ex) publicIpList.1=106.10.53.67 |
| searchFilterName | No | String | 検索するフィルタ名 グローバルIP(publicIp)と割り当てられたサーバ名(associatedServerName)でフィルタリングして検索できます。 Options : publicIp | associatedServerName [大小文字区分なし]searchFilterNameは以下のsearchFilterValue値とmappingして使います。 ex) searchFilterName=publicIp&searchFilterValue=106.10.53.67 ex) searchFilterName=associatedServerName&searchFilterValue=s1669aa4e78c | |
| searchFilterValue | No | String | 検索するフィルタ値 上記のsearchFilterName値とmappingする値を入力します。 | |
| regionNo | No | String | リージョン番号 グローバルIPインスタンスリストを、リージョン(Region)を利用してフィルタリングできます。 regionNoはgetRegionListアクションを通じて取得できます。 | |
| zoneNo | No | String | ZONE番号 グローバルIPインスタンスリストを、ゾーン(zone)を利用してフィルタリングできます。 zoneNoはgetZoneListアクションを通じて取得できます。 フィルタを設定しない場合、該当するリージョン(Region)のゾーン(zone)に属するグローバルIPリストがすべて選択されます。 | |
| pageNo | No | Integer | Min : 0, Max : 2147483647 | ページングされた結果のページ番号 結果値を、pageNoを利用してページング処理することが可能です。 |
| pageSize | No | Integer | Min : 0, Max : 2147483647 | ページングする時に表示する各ページサイズ 結果値を、pageNoを利用してページング処理することが可能です。 |
| sortedBy | No | String | ソート対象 グローバルIPとグローバルIPインスタンス番号でソートできます。 Options : publicIp (グローバルIP) | publicIpInstanceNo (グローバルIPインスタンス番号) [大小文字区分なし]Default : publicIpInstanceNo sortedByは以下のsortingOrderとmappingして使います。 ex) sortedBy=publicIp&sortingOrder=ascending ex) sortedBy=publicIpInstanceNo&sortingOrder=descending | |
| sortingOrder | No | String | ソート順番 上記で設定したsortedByのアセンディング/ディセンディングソートを設定します。 ascending (アセンディング) | descending (ディセンディング) [大小文字区分なし]default : ascending |
レスポンス
レスポンスボディ
例示
リクエスト例示
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>平村zone</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>平村zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</publicIpInstance>
</publicIpInstanceList>
</getPublicIpInstanceListResponse>
この記事は役に立ちましたか?