- HOME
- 提供API一覧
- listPortForwardingRules
listPortForwardingRules
処理概要
ポート転送ルールの設定一覧を取得
注意事項
・なし
リクエスト
・リクエストパラメータ
| Parameter Name | Description | Required |
| id | Lists rule with the specified ID. | false |
| ipaddressid | the id of IP address of the port forwarding services | false |
| keyword | List by keyword | false |
| networkid | list port forwarding rules for ceratin network | false |
・リクエストサンプル
$ ./kick_api.sh command=listPortForwardingRules ipaddress=10.1.1.245
レスポンス
・レスポンスボディ
| Response Name | Description |
| id | the ID of the port forwarding rule |
| cidrlist | the cidr list to forward traffic from |
| ipaddress | the public ip address for the port forwarding rule |
| ipaddressid | the public ip address id for the port forwarding rule |
| networkid | the id of the guest network the port forwarding rule belongs to |
| privateendport | the ending port of port forwarding rule’s private port range |
| privateport | the starting port of port forwarding rule’s private port range |
| protocol | the protocol of the port forwarding rule |
| publicendport | the ending port of port forwarding rule’s private port range |
| publicport | the starting port of port forwarding rule’s public port range |
| state | the state of the rule |
| virtualmachinedisplayname | the VM display name for the port forwarding rule |
| virtualmachineid | the VM ID for the port forwarding rule |
| virtualmachinename | the VM name for the port forwarding rule |
| vmguestip | the vm ip address for the port forwarding rule |
・レスポンスサンプル
【API実行結果】
<?xml version=”1.0″ encoding=”UTF-8″?>
<listportforwardingrulesresponse cloud-stack-version=”4.3.0.2″>
<count>1</count>
<portforwardingrule>
<id>d02bb9c4-a2cb-4530-ae52-4486ae3471a8</id>
<privateport>3389</privateport>
<privateendport>3389</privateendport>
<protocol>tcp</protocol>
<publicport>1050</publicport>
<publicendport>1050</publicendport>
<ipaddressid>c26ea398-7d6e-4a09-a64e-e9db881a44e3</ipaddressid>
<ipaddress>27.11.XXX.XXX</ipaddress>
<state>Active</state>
<cidrlist/>
<vmguestip>10.1.1.245</vmguestip>
<networkid>cc9ce6f4-67eb-4313-8fc4-763836d1da6b</networkid>
</portforwardingrule>
</listportforwardingrulesresponse>