Jump to

• Request
• Response
• Examples

Register a node to a gateway

post

/apiplatform/management/v1/gateways/{gwId}/nodes

Requests registration to a node to the {gwId} gateway. The request must be approved or rejected.

Users requesting this resource must be assigned Gateway Manager role and must be issued the Manage Gateway for the specific gateway.

Request

Supported Media Types

• application/json

Path Parameters

• gwId: string
  A unique ID referencing a specific gateway.

Body ()

Root Schema : CreateNodeRequest

Match All

Show Source

• object NodeIdentity
• object NodeDef

{
    "allOf":[
        {
            "$ref":"#/definitions/NodeIdentity"
        },
        {
            "$ref":"#/definitions/NodeDef"
        }
    ]
}

Nested Schema : NodeIdentity

Type: object

Show Source

• name: string
  The gateway node's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The gateway node's name."
        }
    }
}

Nested Schema : NodeDef

Type: object

Show Source

• configuration(optional): object configuration
• description(optional): string
  The gateway node's description.
• info(optional): object info
• proxyUrls(optional): array proxyUrls
• releaseVersion(optional): string
  The gateway node's release version.
• urls(optional): array urls

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The gateway node's description."
        },
        "releaseVersion":{
            "type":"string",
            "description":"The gateway node's release version."
        },
        "urls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "proxyUrls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "configuration":{
            "type":"object",
            "properties":{
            }
        },
        "info":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : configuration

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : info

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : proxyUrls

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : urls

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The gateway node was created.

Body ()

Root Schema : NodeId

Type: object

Show Source

• id: string
  The gateway node's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The gateway node's ID."
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to register a node to a gateway by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-u apicsadmin:password
-H "Content-Type:application/json"
-d @register-node.json
https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes

{gwId} is the unique of a gateway. To retrieve available gateway Ids, see Get gateways.

Example of Request Body

The following shows an example of the request body in JSON format, included with the request above in a file named register-node.json.

{
	"name": "gateway1",
	"description": "node description",
	"urls": ["http://example.com:8011"],
	"proxyUrls": ["http://proxy-us.example.com:80"]
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Thu, 16 Mar 2017 07:24:42 GMT
Content-Length:  12
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-000267d0
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including ID of the node.

{
    "id": "101"
}

Back to Top