Description
describePortFwds is used to list the detailed information of multiple Port Forwarding services.
1.If no parameter is specified, no Port Forwarding service is listed.
2.Give portFwdBusinessServiceId or orderUuid to list specific Port Forwarding services, for example 1~3.
Parameter vpcBusinessServiceId is used only when there are no parameters portFwdBusinessServiceId or orderUuid.
3.Give vpcBusinessServiceId to list Port Forwarding services in the specific VPC, for example 4.
Request Parameter
| Parameter | Description | Note |
|---|---|---|
| portFwdBusinessServiceId (not a necessary parameter) |
list of business service ID of Port Forwarding Type : String Default Value : No Whether it is plural : Yes |
Multiple values can be supported. |
| orderUuid (not a necessary parameter) |
order UUID list Type : String Default Value : No Whether it is plural : Yes |
Multiple values can be supported. |
| vpcBusinessServiceId (not a necessary parameter) |
business service ID of VPC Type : String Default Value : No Whether it is plural : No |
Response Parameter
| Parameter | Description | Note |
|---|---|---|
requestId (not a necessary parameter) |
request ID Type : JSON value : string Whether it is plural : No |
automatically produced by the system |
| portFwdList |
Port Forwarding list Type : JSON value : array Whether it is plural : Yes |
PortFwdEntry list |
Response Example
ex 1:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describePortFwds
&portFwdBusinessServiceId=VT55020001IOSJ
&portFwdBusinessServiceId=VT55020001IOSW
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
ex 2:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describePortFwds
&orderUuid=031a2e0f-3232-4e9f-9a97-2d50120de7b4
&orderUuid=f51ac698-5f0e-4be5-aa84-9a719b5cfa2d
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
ex 3:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describePortFwds
&portFwdBusinessServiceId=VT55020001IOSJ
&orderUuid=f51ac698-5f0e-4be5-aa84-9a719b5cfa2d
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
ex 4:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describePortFwds
&vpcBusinessServiceId=VV55020001IOSE
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
Response Example
{
"portFwdList": [
{
"applyDate": "2016-10-01T01:01:01Z",
"businessTag": null,
"description": null,
"endDate": null,
"name": "22",
"orderUuid": "031a2e0f-3232-4e9f-9a97-2d50120de7b4",
"originalIp": "210.61.100.1",
"originalPort": 80,
"portFwdBusinessServiceId": "VT55020001IOSJ",
"provisionMessage": "PROVISION_SUCCESS",
"provisionStatus": "provisionok",
"regionId": null,
"startDate": "2016-10-01T01:01:01Z",
"translatedIp": "192.168.0.1",
"translatedPort": 8080
},
{
"applyDate": "2016-10-01T01:01:01Z",
"businessTag": null,
"description": null,
"endDate": null,
"name": "portFwd_3",
"orderUuid": "f51ac698-5f0e-4be5-aa84-9a719b5cfa2d",
"originalIp": "210.61.100.2",
"originalPort": 90,
"portFwdBusinessServiceId": "VT55020001IOSW",
"provisionMessage": "PROVISION_SUCCESS",
"provisionStatus": "provisionok",
"regionId": null,
"startDate": "2016-10-01T01:01:01Z",
"translatedIp": "172.23.0.2",
"translatedPort": 9090
}
],
"requestId": "2c957f6158674580015867476a020001"
}