Skip to main content
API Explorer|API Explorer
Resource Center/Network Service/Network Service Operations/Port Forwarding Operations
POSTPort Forwarding OperationsSince 0.6SynchronousAuth Required

CreatePortForwardingRule

CreatePortForwardingRule

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • vipUuidStringRequired

      The VIP UUID.

    • vipPortStartIntegerRequired

      The VIP start port.

    • vipPortEndInteger

      Optional. The VIP end port. If not specified, the value of vipPortStart will be used by default.

    • privatePortStartInteger

      Optional. The start port of the guest IP address (the IP address of the VM NIC). If not specified, the value of vipPortStart will be used by default.

    • privatePortEndInteger

      Optional. The end port of the guest IP address (the IP address of the VM NIC). If not specified, the value of vipPortEnd will be used by default.

    • protocolTypeStringRequired

      The protocol type of the network traffic.

    • vmNicUuidString

      Optional. The VM NIC UUID.

    • allowedCidrString

      Optional. The source CIDR. The port forwarding rule is only applied to the traffics of the source CIDR. If not specified, 0.0.0.0/0 will be used by default.

    • nameStringRequired

      The resource name.

    • descriptionString

      Optional. The detailed description of the resource.

    • resourceUuidString

      Optional. The resource UUID. If specified, the system will not allocate randomly a UUID to the resource.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryPortForwardingRuleInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • vipIpStringRequired

      The IP address of the VIP.

    • guestIpStringRequired

      The IP address of the VM NIC.

    • vipUuidStringRequired

      The VIP UUID.

    • vipPortStartIntegerRequired

      The start port of the VIP.

    • vipPortEndIntegerRequired

      The end port of the VIP.

    • privatePortStartIntegerRequired

      The start port of guest IP address.

    • privatePortEndIntegerRequired

      The end port of guest IP address.

    • vmNicUuidStringRequired

      The VM NIC UUID.

    • protocolTypeStringRequired

      The protocol type of the network traffic.

    • stateStringRequired

      The state of the rule.

    • allowedCidrStringRequired

      The source CIDR. The port forwarding rule is only applied to the traffics of the source CIDR.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

Endpoint

POST/zstack/v1/port-forwarding

/zstack/v1/port-forwarding

Operation ID

CreatePortForwardingRule

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/port-forwarding' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"vipUuid":"<vipUuid>","vipPortStart":1,"vipPortEnd":1,"privatePortStart":1,"privatePortEnd":1,"protocolType":"<protocolType>","vmNicUuid":"<vmNicUuid>","allowedCidr":"<allowedCidr>","name":"<name>","description":"<description>","resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "895a8ce93d274db78e2ef1462f8b8a29", "name": "TestAttachRule", "description": "test atatch rule", "vipIp": "192.168.0.187", "guestIp": "10.0.0.244", "vipUuid": "6151c96fd2ac4d6cbd8f8eedffc06de5", "vipPortStart": 33.0, "vipPortEnd": 33.0, "privatePortStart": 33.0, "privatePortEnd": 33.0, "vmNicUuid": "581ea3b08aef4096ac24e160f1ab0f8e", "protocolType": "TCP", "state": "Enabled", "allowedCidr": "0.0.0.0/0", "createDate": "Jun 7, 2017 9:20:10 PM", "lastOpDate": "Jun 7, 2017 9:20:10 PM" } }

Change History

This API has no change history records yet.

View all change history