Create Compute Gateway

Create Compute Gateway

Create a new compute gateway.

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/compute-gateways
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Request Body

Compute Gateway Specification instance

ComputeGatewaySpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "projectId": "e058",
    "networks": [
        {}
    ],
    "natRules": [
        {
            "index": 0,
            "targetLink": "/iaas/api/load-balancers/try6-45ef, /iaas/api/machines/ht54-a472/network-interfaces/dyd6-d67e"
        }
    ]
}
{
    "name": "string",
    "projectId": "e058",
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "customProperties": {
        "customProperties": "string"
    },
    "networks": [
        "string"
    ],
    "natRules": [
        {
            "ruleId": "string",
            "kind": "NAT44",
            "type": "DNAT",
            "index": 0,
            "protocol": "TCP, UDP",
            "sourceIPs": "any, 10.20.156.101",
            "sourcePorts": "any, 80, 5000-5100",
            "destinationPorts": "any, 80, 5000-5100",
            "destinationAddress": "any, 10.20.156.101",
            "targetLink": "/iaas/api/load-balancers/try6-45ef, /iaas/api/machines/ht54-a472/network-interfaces/dyd6-d67e",
            "translatedPorts": "any, 80, 5000-5100",
            "description": "string"
        }
    ]
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
projectId
Required

The id of the project the current user belongs to.

string
deploymentId
Optional

The id of the deployment that is associated with this resource

object
customProperties
Optional

Additional custom properties that may be used to extend this resource.

array of string
networks
Required

List of networks

array of object
natRules
Required

List of NAT Rules

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns RequestTracker of type(s) application/json 
"RequestTracker Object"
integer As int32 As int32
progress
Required

Progress of the request as percentage.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
array of string
resources
Optional

Collection of resources.

string
name
Optional

Name of the operation.

string
id
Required

ID of this request.

string
selfLink
Required

Self link of this request.

string
deploymentId
Optional

ID of the deployment, this request is connected to.


400

Invalid Request - bad data

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","natRules":["object"],"networks":["string"],"projectId:"string"}' https://{api_host}/iaas/api/compute-gateways
On This Page
Compute Gateway Operations
GET
Get Compute Gateways
POST
Create Compute Gateway
GET
Get Compute Gateway
DELETE
Delete Compute Gateway