Versions Compared

Version Old Version 4 New Version 5
Changes made by

Kyle Miller

Kyle Miller

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

The SCSP SEND method applies to both named and unnamed objects. The SEND request lets you explicitly transmit allows explicit transmission of a newly written object from a source cluster to a remote one, such as for keeping two clusters immediately synchronized. As of Swarm 11.2, the feed SEND method works with any feed type, so that it can force synchronous processing of a specific object on one or more of those feeds.

...

Argument

Values, Examples

Notes

admin

none

SEND can only be used by an admin user. This requires the admin query argument and a system user/password sent as a digest.

feedid

all | integer

feedid=all 

feedid=1&feedid=3

Specifies one or more specific feeds as the replication destination. Reference existing feed IDs (feedid=1&feedid=3) or use the special value “all” to refer to all feeds, including no feed. To find the ID number for a feed in the Swarm UI, select Cluster > Feeds, and locate the ID column:

Image RemovedImage Added

If an integer value is not an existing feed, Swarm returns a 400 Bad Request error. If the object being sent does not match the feed definition (because of a domain restriction), the SEND operation succeeds, but no data is transferred.

feedtype

all | search | replication | s3backup

feedtype=all

feedtype=replication
   &feedtype=search

Specifies one or more types of feeds as the replication destination, from among these values: search, indexing, replication, s3backup.  (The values search and indexing are synonymous.) Use the special value “all” to refer to all feed types, including no feed.

If the feedtype isn't a valid value, Swarm returns a 400 Bad Request error. If the object being sent does not match the feed definition (because of a domain restriction), the SEND operation succeeds, but no data is transferred.

timeout

true | number of seconds | false

timeout=true

timeout=60

Sets how long to wait for replication to complete; if disabled (false; not recommended), feed processing can go on indefinitely if a feed is blocked. 

Using timeout=true waits for the Swarm setting scsp.defaultFeedSendTimeout time in seconds, which defaults to 30.

Specifying a positive number for the timeout overrides the value in the Swarm setting.

...