AclToken
Name |
Type |
Description |
|
Set ID of token |
|
|
Set name of token |
|
|
Set rules for token |
|
Set type of token |
BlockingQueryOptions
Name |
Type |
Description |
|
Set index indicating that the client wishes to wait for any changes subsequent to that index. |
|
|
Specifying a maximum duration for the blocking request. This is limited to 10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively). |
Check
Name |
Type |
Description |
|
Set the ID of check |
|
|
Set the name of check |
|
|
Set the name of node |
|
|
Set the human-readable note of check |
|
|
Set the output of check |
|
|
Set the ID of service with which this check associated |
|
|
Set the name of service with which this check associated |
|
Set the status of check |
CheckOptions
Name |
Type |
Description |
|
Set HTTP address to check. Also you should set checking interval |
|
|
Set check ID |
|
|
Set checking interval |
|
|
Set check name. This is mandatory field |
|
|
Set check notes |
|
|
Set path to checking script. Also you should set checking interval |
|
|
Set the service ID to associate the registered check with an existing service provided by the agent. |
|
Set the check status to specify the initial state of the health check. |
||
|
Set TCP address to check. Also you should set checking interval |
|
|
Set Time to Live of check. |
ConsulClientOptions
Name |
Type |
Description |
|
Set the ACL token. When provided, the client will use this token when making requests to the Consul by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' ACL policy, is used. |
|
|
Set the datacenter name. When provided, the client will use it when making requests to the Consul by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried. |
|
|
Set Consul host. Defaults to `localhost` |
|
Set the trust options. |
||
|
Set Consul HTTP API port. Defaults to `8500` |
|
|
Set whether SSL/TLS is enabled |
|
|
Sets the amount of time (in milliseconds) after which if the request does not return any data within the timeout period an failure will be passed to the handler and the request will be closed. |
|
|
Set whether all server certificates should be trusted |
Coordinate
CoordinateList
Name |
Type |
Description |
|
Set Consul index, a unique identifier representing the current state of the requested coordinates |
|
|
Set list of coordinates |
DcCoordinates
Name |
Type |
Description |
|
Set datacenter |
|
|
Set list of servers in datacenter |
Event
Name |
Type |
Description |
|
Set ID of event |
|
|
Set the Lamport clock time |
|
|
Set name of event |
|
|
Set regular expression to filter by node name |
|
|
Set payload of event |
|
|
Set regular expression to filter by service |
|
|
Set regular expression to filter by tag |
|
|
Set version |
EventList
Name |
Type |
Description |
|
Set Consul index, a unique identifier representing the current state of the requested events |
|
|
Set list of events |
EventOptions
KeyValue
Name |
Type |
Description |
|
Set the internal index value that represents when the entry was created. |
|
|
Set the flags attached to this entry. Clients can choose to use this however makes sense for their application. |
|
|
Set the key |
|
|
Set the number of times this key has successfully been acquired in a lock. |
|
|
Set the last index that modified this key. |
|
|
Set the session that owns the lock |
|
|
Set the value |
KeyValueList
Name |
Type |
Description |
|
Set Consul index |
|
|
Set list of key/value pairs |
KeyValueOptions
Name |
Type |
Description |
|
Set session ID for lock acquisition operation. |
|
|
Set the Check-And-Set index. If the index is |
|
|
Set the flags. Flags is an value between |
|
|
Set session ID for lock release operation. |
MaintenanceOptions
Name |
Type |
Description |
|
Set maintenance mode to enabled: |
|
|
Set the ID of service. This field is required. |
|
|
Set the reason message. If provided, its value should be a text string explaining the reason for placing the service into maintenance mode. This is simply to aid human operators. |
Node
NodeList
Name |
Type |
Description |
|
Set Consul index, a unique identifier representing the current state of the requested list of nodes |
|
|
Set list of nodes |
NodeQueryOptions
Name |
Type |
Description |
Set options for blocking query |
||
|
Set node name for sorting the list in ascending order based on the estimated round trip time from that node. |
Service
Name |
Type |
Description |
|
Set service address |
|
|
Set ID of service |
|
|
Set service name |
|
|
Set node name |
|
|
Set node address |
|
|
Set service port |
|
|
Set list of service tags |
ServiceEntry
ServiceEntryList
Name |
Type |
Description |
|
Set Consul index, a unique identifier representing the current state of the requested list of services |
|
|
Set list of services |
ServiceList
Name |
Type |
Description |
|
Set Consul index, a unique identifier representing the current state of the requested list of services |
|
|
Set list of services |
ServiceOptions
Name |
Type |
Description |
|
Set service address |
|
Set check options of service |
||
|
Set the ID of session |
|
|
Set service name |
|
|
Set service port |
|
|
Set list of tags associated with service |
ServiceQueryOptions
Name |
Type |
Description |
Set options for blocking query |
||
|
Set node name for sorting the list in ascending order based on the estimated round trip time from that node. |
|
|
Set tag for filtering request results |
Session
Name |
Type |
Description |
|
Set the list of associated health checks |
|
|
Set the create index of session |
|
|
Set the ID of node |
|
|
Set Consul index |
|
|
Set the Lock delay of session |
|
|
Set the ID of node |
SessionList
Name |
Type |
Description |
|
Set Consul index, a unique identifier representing the current state of the requested list of sessions |
|
|
Set list of sessions |
SessionOptions
Name |
Type |
Description |
Set the behavior when a session is invalidated. The release behavior is the default if none is specified. |
||
|
Set a list of associated health checks. It is highly recommended that, if you override this list, you include the default "serfHealth" |
|
|
Set the lock-delay period. |
|
|
Set the human-readable name for the Session |
|
|
Set the node to which the session will be assigned |
|
|
Set the TTL interval. When TTL interval expires without being renewed, the session has expired and an invalidation is triggered. If specified, it must be between 10s and 86400s currently. |
TxnError
TxnKVOperation
Name |
Type |
Description |
|
Set the flags attached to this entry. Clients can choose to use this however makes sense for their application. |
|
|
Set the index used for locking, unlocking, and check-and-set operations. |
|
|
Set the key |
|
|
Set the session used for locking, unlocking, and check-and-set operations. |
|
Set the type of operation to perform |
||
|
Set the value |
TxnRequest
TxnResponse
Name |
Type |
Description |
|
Adds error to this response |
|
|
Returns the number of errors in this response |
|
|
Returns the number of results in this response |