概要
グローバルIPインスタンスリスト照会
説明
グローバルIPインスタンスリストを照会します。
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| isAssociated | No | Boolean | 割り当てられたグローバルIP、割り当てられてないグローバルIPを照会できます。 | |
| publicIpInstanceNoList | No | List |
重複不可 | 照会するグローバルIPインスタンス番号リスト |
| publicIpList | No | String | Min : 5, Max : 15 | 照会するグローバルIPリスト |
| searchFilterName | No | String | グローバルIP(publicIp) | 割り当てられたサーバ名(associatedServerName) | |
| searchFilterValue | No | String | 照会する値 | |
| regionNo | No | String | 入力できるステータスはgetRegionList アクションを通じて取得できます。 | |
| zoneNo | No | String | グローバルIPインスタンスリストをZONEを利用してフィルタリングできます。 フィルタを設定しない場合、該当リージョンのZONEに属するグローバルIPリストがすべて選択されます。 |
|
| pageNo | No | Integer | Min : 0, Max : 2147483647 | 件数が多い場合、ページサイズに該当するページ番号 |
| pageSize | No | Integer | Min : 0, Max : 2147483647 | 一つのページで照会するページサイズ |
| sortedBy | No | String | リスト結果に対するソートコラムを決定できます。 グローバルIP(publicIp) | グローバルIPインスタンス番号(publicIpInstanceNo) [大小文字区分なし] Default : グローバルIPインスタンス番号(publicIpInstanceNo) |
|
| sortingOrder | No | String | アセンディング、ディセンディングに対して、リスト結果にorderingを決定できます。 アセンディング(ascending) | ディセンディング(descending) [大小文字区分なし] Default : アセンディング(ascending) |
レスポンスデータタイプ
- PublicIpInstanceListタイプ
| PublicIpInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| PublicIpInstance |
|---|
| private String publicIpInstanceNo; |
| private String publiclIp; |
| private String publicIpDescription; |
| private Date createDate; |
| private String publicIpInstanceStatusName; |
| private CommonCode publicIpInstanceStatus; |
| private CommonCode publicIpInstanceOperation; |
| private CommonCode publicIpKindType; |
| private ServerInstance serverInstanceAssociatedWithPublicIp; |
| private Region region; |
| private Zone zone; |
例示
呼び出し
ncloud server getPublicIpInstanceList --publicIpList 192.168.60.117 192.168.60.115
レスポンス
{
"getPublicIpInstanceListResponse": {
"requestId": "dbf5e5bc-97c0-4164-9ee5-1128e50f5617",
"returnCode": "0",
"returnMessage": "success",
"totalRows": 2,
"publicIpInstanceList": [
{
"publicIpInstanceNo": "396562",
"publicIp": "192.168.60.115",
"publicIpDescription": "",
"createDate": "2018-02-13T13:46:23+0900",
"publicIpInstanceStatusName": "created",
"publicIpInstanceStatus": {
"code": "CREAT",
"codeName": "NET CREAT State"
},
"publicIpInstanceOperation": {
"code": "NULL",
"codeName": "NET NULL OP"
},
"publicIpKindType": {
"code": "GEN",
"codeName": "General"
},
"serverInstanceAssociatedWithPublicIp": {},
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "KR-1 zone",
"regionNo" : "1"
}
},
{
"publicIpInstanceNo": "397030",
"publicIp": "192.168.60.117",
"publicIpDescription": "test",
"createDate": "2018-02-20T21:32:24+0900",
"publicIpInstanceStatusName": "created",
"publicIpInstanceStatus": {
"code": "CREAT",
"codeName": "NET CREAT State"
},
"publicIpInstanceOperation": {
"code": "NULL",
"codeName": "NET NULL OP"
},
"publicIpKindType": {
"code": "GEN",
"codeName": "General"
},
"serverInstanceAssociatedWithPublicIp": {},
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "KR-1 zone",
"regionNo" : "1"
}
}
]
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<getPublicIpInstanceListResponse>
<requestId>dbf5e5bc-97c0-4164-9ee5-1128e50f5617</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>2</totalRows>
<publicIpInstanceList>
<publicIpInstanceNo>396562</publicIpInstanceNo>
<publicIp>192.168.60.115</publicIp>
<publicIpDescription></publicIpDescription>
<createDate>2018-02-13T13:46:23+0900</createDate>
<publicIpInstanceStatusName>created</publicIpInstanceStatusName>
<publicIpInstanceStatus>
<code>CREAT</code>
<codeName>NET CREAT State</codeName>
</publicIpInstanceStatus>
<publicIpInstanceOperation>
<code>NULL</code>
<codeName>NET NULL OP</codeName>
</publicIpInstanceOperation>
<publicIpKindType>
<code>GEN</code>
<codeName>General</codeName>
</publicIpKindType>
<serverInstanceAssociatedWithPublicIp/>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>KR-1 zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</publicIpInstanceList>
<publicIpInstanceList>
<publicIpInstanceNo>397030</publicIpInstanceNo>
<publicIp>192.168.60.117</publicIp>
<publicIpDescription>test</publicIpDescription>
<createDate>2018-02-20T21:32:24+0900</createDate>
<publicIpInstanceStatusName>created</publicIpInstanceStatusName>
<publicIpInstanceStatus>
<code>CREAT</code>
<codeName>NET CREAT State</codeName>
</publicIpInstanceStatus>
<publicIpInstanceOperation>
<code>NULL</code>
<codeName>NET NULL OP</codeName>
</publicIpInstanceOperation>
<publicIpKindType>
<code>GEN</code>
<codeName>General</codeName>
</publicIpKindType>
<serverInstanceAssociatedWithPublicIp/>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>KR-1 zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</publicIpInstanceList>
</getPublicIpInstanceListResponse>