NodeResource
NodeResource REST endpoint to access and manipulate specific Node data. Copyright 2013 WANdisco.
The following resources are part of this group:
- /node/{nodeIdentity}
- /node/{nodeIdentity}/attributes
- /node/{nodeIdentity}/membership
- /node/{nodeIdentity}/membershipfris
- /node/{nodeIdentity}/statemachines
- /node/{nodeIdentity}/attributes/delete
- /node/{nodeIdentity}/ecosystem/removenodes
- /node/{nodeIdentity}/statemachine/{dsmId}
- /node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput
- /node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered
- /node/{nodeIdentity}/statemachine/{dsmId}/lastoutput
- /node/{nodeIdentity}/statemachine/{dsmId}/membership
- /node/{nodeIdentity}/statemachine/{dsmId}/prepareToUnsideline
- /node/{nodeIdentity}/statemachine/{dsmId}/startoutput
- /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput
- /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput
- /node/{nodeIdentity}/statemachine/{dsmId}/unsideline
- /node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}
- /node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeId}
- /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove
- /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set
/node/{nodeIdentity}
Mount Point: /node/{nodeIdentity}
GET
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml application/json |
a node with a given identity.
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Request Body
element: | inductionTicket |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/attributes
Mount Point: /node/{nodeIdentity}/attributes
The following operations are supported on this resource:
GET
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml application/json |
the attributes for the node with the given identity.
PUT
Update the attributes of a com.wandisco.nodes.Node.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Request Body
element: | attributes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
DELETE
Remove one or more attributes from a com.wandisco.nodes.Node.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Request Body
element: | attributes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/membership
Mount Point: /node/{nodeIdentity}/membership
POST
Create/deploy a com.wandisco.nodes.groups.Membership from the MembershipDTO presented to the resource. The URL returned is the location of task associated with the deployment of the new membership. This method is a POST as we're creating a new resource.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Request Body
element: | membership |
media types: | application/xml application/json |
the description of the membership to be deployed
Response Body
element: | (custom) |
media types: | */* application/xml |
the URI of the task associated with the deployment of the membership
/node/{nodeIdentity}/membershipfris
Mount Point: /node/{nodeIdentity}/membershipfris
GET
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml application/json |
a list of membership-family representative identities for the node.
/node/{nodeIdentity}/statemachines
Mount Point: /node/{nodeIdentity}/statemachines
GET
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
history | (no documentation provided) | query | false |
Response Body
element: | (custom) |
media types: | application/xml application/json |
(no documentation provided)
/node/{nodeIdentity}/attributes/delete
Mount Point: /node/{nodeIdentity}/attributes/delete
PUT
Workaround for bug in sun.net.www.protocol.http.HttpURLConnection, which does not allow a body to be sent with a DELETE operation. The bug, 7157360, is fixed in Java8. To see the bug, go to http://bugs.java.com/view_bug.do?bug_id=7157360, but you will have to enter the bug ID in the form again.
NodeResource#deleteNodeAttributes(nodeIdentity, nodeAttributesDTO) for the actual implementation.Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Request Body
element: | attributes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/ecosystem/removenodes
Mount Point: /node/{nodeIdentity}/ecosystem/removenodes
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path |
Request Body
element: | nodes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}
GET
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path | |
history | (no documentation provided) | query | false |
Response Body
element: | (custom) |
media types: | application/xml application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Request Body
element: | nodes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered
GET
Note different outputs: plain text or xml/json if there's an exception.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml text/plain application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/lastoutput
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/lastoutput
GET
Note different outputs: plain text or xml/json if there's an exception.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml text/plain application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/membership
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/membership
GET
Find the membership associated with the given dsm.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/prepareToUnsideline
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/prepareToUnsideline
PUT
Note different outputs: unsideline threshold is plain text. xml/json if there's an exception.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml text/plain application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/startoutput
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/startoutput
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Request Body
element: | nodes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/unsideline
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/unsideline
PUT
Produces xml/json if there's an exception.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path | |
membershipIdentity | (no documentation provided) | query | |
resumeFrom | (no documentation provided) | query |
Response Body
element: | (custom) |
media types: | application/xml application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path | |
membershipIdentity | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml application/json |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeId}
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeId}
DELETE
Remove nodes from the specified DSM.
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path | |
nodeIdToRemove | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Request Body
element: | nodes |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set
Mount Point: /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set
PUT
Parameters
name | description | type | default |
---|---|---|---|
nodeIdentity | (no documentation provided) | path | |
dsmId | (no documentation provided) | path |
Request Body
element: | skipThreshold |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)