Nodes

Nodes

Services for GCS endpoints may be deployed on multiple different physical resources. The Nodes API allows an administrator to manage those nodes.

Nodes Overview

Method API Path Description

GET

/​api/​nodes

List endpoint nodes

POST

/​api/​nodes

Create a new node

GET

/​api/​nodes/​{node_id}

Get node

PUT

/​api/​nodes/​{node_id}

Update a node

PATCH

/​api/​nodes/​{node_id}

Update a node

DELETE

/​api/​nodes/​{node_id}

Delete a node

Details

List endpoint nodes

GET /api/nodes

Get the endpoint’s list of nodes.

This operation requires either the endpoint to have the public property set to true or the caller to have a role that allows viewing this endpoint or a collection on it.

Authorization

  • PublicAuthorizer

  • RoleAuthorizer:

    • endpoint:owner

    • endpoint:administrator

    • endpoint:activity_manager

    • endpoint:activity_monitor

    • collection:administrator:*

    • collection:activity_manager:*

    • collection:activity_monitor:*

    • collection:access_manager:*

  • StorageGatewayAuthorizer

    • *

Query Parameters

Parameter Type Description

page_size

integer <int>

Maximum page size for a paginated response

marker

string

Pagination marker for a paginated response

Responses

200 - List nodes response
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "data": [
    {
      "DATA_TYPE": "node#1.0.0",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "incoming_port_range": [
        65535,
        65535
      ],
      "ip_addresses": [
        "string"
      ],
      "outgoing_port_range": [
        65535,
        65535
      ],
      "status": "active"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}
401 - Unauthorized

Create a new node

POST /api/nodes

Create a new node to describe a host which is providing service for this endpoint. This adds the node’s IP address to the DNS record for this endpoint’s GCS Manager and for all collections.

On success returns a copy of the created Node with the system generated id added.

Authorization

  • RoleAuthorizer:

    • endpoint:owner

    • endpoint:administrator

Request body

Content-Type: application/json

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Version 1.1.0 adds support for setting the data interface on a node.

Version 1.2.0 adds support for setting an IPv6 data interface on a node.

One of the following schemas:

​

Example 
{
  "DATA_TYPE": "node#1.0.0",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "incoming_port_range": [
    65535,
    65535
  ],
  "ip_addresses": [
    "string"
  ],
  "outgoing_port_range": [
    65535,
    65535
  ],
  "status": "active"
}

Responses

200 - Create node response
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "data": [
    {
      "DATA_TYPE": "node#1.0.0",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "incoming_port_range": [
        65535,
        65535
      ],
      "ip_addresses": [
        "string"
      ],
      "outgoing_port_range": [
        65535,
        65535
      ],
      "status": "active"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}
400 - Bad Request
401 - Unauthorized
403 - Permission denied
Content-Type: application/json

One of the following schemas:

Name

Type

Description

code

string permission_denied

http_response_code

any type 403

detail

string or MissingRequiredRole

Name

Type

Description

code

string permission_denied

http_response_code

any type 403

detail

string or LimitExceeded

​

{
  "code": "string",
  "http_response_code": 100,
  "detail": null,
  "DATA_TYPE": "result#1.0.0",
  "data": [
    {}
  ],
  "has_next_page": false,
  "marker": "string",
  "message": "string"
}
415 - Unsupported media type
422 - Unprocessable entity

Details

Get node

GET /api/nodes/{node_id}

Get information about one of the endpoint’s node.

This operation requires either the endpoint to have the public property set to true or the caller to have a role that allows viewing this Endpoint or a Collection on it.

Authorization

  • PublicAuthorizer

  • RoleAuthorizer:

    • endpoint:owner

    • endpoint:administrator

    • endpoint:activity_manager

    • endpoint:activity_monitor

    • collection:administrator:*

    • collection:activity_manager:*

    • collection:activity_monitor:*

    • collection:access_manager:*

  • StorageGatewayAuthorizer

    • *

Path parameters

▷ node_id

Id of the node

Parameter Type Description

node_id (required)

string <uuid>

Id of the node

Responses

200 - Get node response
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "data": [
    {
      "DATA_TYPE": "node#1.0.0",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "incoming_port_range": [
        65535,
        65535
      ],
      "ip_addresses": [
        "string"
      ],
      "outgoing_port_range": [
        65535,
        65535
      ],
      "status": "active"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}
401 - Unauthorized
404 - Not found

Update a node

PUT /api/nodes/{node_id}

Update a node, replacing all properties with those in the input. This operation optionally returns the node’s definition after the update if the include=node query parameter is passed to this operation.

Authorization

  • RoleAuthorizer:

    • endpoint:owner

    • endpoint:administrator

Path parameters

▷ node_id

Id of the node

Parameter Type Description

node_id (required)

string <uuid>

Id of the node

Query Parameters

Parameter Type Description

include

array of string node

Flag indicating whether to request all roles assignments for the endpoint or collection.

Request body

Content-Type: application/json

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Version 1.1.0 adds support for setting the data interface on a node.

Version 1.2.0 adds support for setting an IPv6 data interface on a node.

One of the following schemas:

​

Example 
{
  "DATA_TYPE": "node#1.0.0",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "incoming_port_range": [
    65535,
    65535
  ],
  "ip_addresses": [
    "string"
  ],
  "outgoing_port_range": [
    65535,
    65535
  ],
  "status": "active"
}

Responses

200 - Update node response
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "data": [
    {
      "DATA_TYPE": "node#1.0.0",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "incoming_port_range": [
        65535,
        65535
      ],
      "ip_addresses": [
        "string"
      ],
      "outgoing_port_range": [
        65535,
        65535
      ],
      "status": "active"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}
400 - Bad Request
401 - Unauthorized
403 - Permission denied
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "http_response_code": 100,
  "detail": null,
  "DATA_TYPE": "result#1.0.0",
  "data": [
    {}
  ],
  "has_next_page": false,
  "marker": "string",
  "message": "string"
}
404 - Not found
415 - Unsupported media type
422 - Unprocessable entity

Update a node

PATCH /api/nodes/{node_id}

Update a node, changing only the properties included in the input document. Items explicitly set to null in the input are removed from the Node document. This operation optionally returns the node definition after applying the changes in the input if the include=node query parameter is passed to this operation.

Authorization

  • RoleAuthorizer:

    • endpoint:owner

    • endpoint:administrator

Path parameters

▷ node_id

Id of the node

Parameter Type Description

node_id (required)

string <uuid>

Id of the node

Query Parameters

Parameter Type Description

include

array of string node

Flag indicating whether to request all roles assignments for the endpoint or collection.

Request body

Content-Type: application/json

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as data transfer nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Version 1.1.0 adds support for setting the data interface on a node.

Version 1.2.0 adds support for setting an IPv6 data interface on a node.

One of the following schemas:

​

Example 
{
  "DATA_TYPE": "node#1.0.0",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "incoming_port_range": [
    65535,
    65535
  ],
  "ip_addresses": [
    "string"
  ],
  "outgoing_port_range": [
    65535,
    65535
  ],
  "status": "active"
}

Responses

200 - Update node response
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "data": [
    {
      "DATA_TYPE": "node#1.0.0",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "incoming_port_range": [
        65535,
        65535
      ],
      "ip_addresses": [
        "string"
      ],
      "outgoing_port_range": [
        65535,
        65535
      ],
      "status": "active"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}
400 - Bad Request
401 - Unauthorized
403 - Permission denied
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "http_response_code": 100,
  "detail": null,
  "DATA_TYPE": "result#1.0.0",
  "data": [
    {}
  ],
  "has_next_page": false,
  "marker": "string",
  "message": "string"
}
404 - Not found
415 - Unsupported media type
422 - Unprocessable entity

Delete a node

DELETE /api/nodes/{node_id}

Delete the Node document for the given node.

Authorization

  • RoleAuthorizer:

    • endpoint:owner

    • endpoint:administrator

Path parameters

▷ node_id

Id of the node

Parameter Type Description

node_id (required)

string <uuid>

Id of the node

Responses

200 - Delete node response
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "DATA_TYPE": "result#1.0.0",
  "code": "string",
  "data": [
    {}
  ],
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}
401 - Unauthorized
403 - Permission denied
Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

​

{
  "code": "string",
  "http_response_code": 100,
  "detail": null,
  "DATA_TYPE": "result#1.0.0",
  "data": [
    {}
  ],
  "has_next_page": false,
  "marker": "string",
  "message": "string"
}
404 - Not found