Description
describeNats is used to list the detailed information of multiple NAT services.
1.If no parameter is specified, no NAT service is listed.
2.Give natBusinessServiceId or orderUuid to list specific NAT services, for example 1~3.
Parameter vpcBusinessServiceId is used only when there are no parameters natBusinessServiceId or orderUuid.
3.Give vpcBusinessServiceId to list NAT services in the specific VPC, for example 4.
Request Parameter
| Parameter | Description | Note |
|---|---|---|
| natBusinessServiceId (not a necessary parameter) |
list of business service ID of NAT 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 |
| natList |
NAT list Type : JSON value : array Whether it is plural : Yes |
NatEntry list |
Response Example
ex 1:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeNats
&natBusinessServiceId=VT55020001IOST
&natBusinessServiceId=VT55020001IOSU
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
ex 2:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeNats
&orderUuid=977fbd0a-b8a0-4db6-b373-57e9482d8a28
&orderUuid=f21ce881-402c-4c00-bc6b-149d9e4ffafe
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
ex 3:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeNats
&natBusinessServiceId=VT55020001IOST
&orderUuid=f21ce881-402c-4c00-bc6b-149d9e4ffafe
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
ex 4:
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=describeNats
&vpcBusinessServiceId=VV55020001IOSE
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}
Response Example
{
"natList": [
{
"applyDate": "2016-10-01T01:01:01Z",
"businessTag": null,
"description": null,
"endDate": null,
"name": "nat111",
"natBusinessServiceId": "VT55020001IOST",
"orderUuid": "977fbd0a-b8a0-4db6-b373-57e9482d8a28",
"originalIp": "210.61.223.75",
"provisionMessage": "PROVISION_SUCCESS",
"provisionStatus": "provisionok",
"regionId": null,
"startDate": "2016-10-01T01:01:01Z",
"translatedIp": "172.23.0.0"
},
{
"applyDate": "2016-10-01T01:01:01Z",
"businessTag": null,
"description": null,
"endDate": null,
"name": "nat_hws_223_84",
"natBusinessServiceId": "VT55020001IOSU",
"orderUuid": "f21ce881-402c-4c00-bc6b-149d9e4ffafe",
"originalIp": "210.61.223.84",
"provisionMessage": "PROVISION_SUCCESS",
"provisionStatus": "provisionok",
"regionId": null,
"startDate": "2016-10-01T01:01:01Z",
"translatedIp": "192.168.88.88"
}
],
"requestId": "2c957f6158608b790158609f8005000a"
}