Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
arangodb/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md

1.1 KiB
Raw Blame History

@startDocuBlock get_admin_server_role @brief Get to know whether this server is a Coordinator or DB-Server

@RESTHEADER{GET /_admin/server/role, Return role of a server in a cluster}

@RESTDESCRIPTION Returns the role of a server in a cluster. The role is returned in the role attribute of the result. Possible return values for role are:

  • SINGLE: the server is a standalone server without clustering
  • COORDINATOR: the server is a coordinator in a cluster
  • PRIMARY: the server is a primary database server in a cluster
  • SECONDARY: the server is a secondary database server in a cluster
  • AGENT: the server is an agency node in a cluster
  • UNDEFINED: in a cluster, UNDEFINED is returned if the server role cannot be determined.

@RESTRETURNCODES

@RESTRETURNCODE{200} Is returned in all cases.

@RESTREPLYBODY{error,boolean,required,} always false

@RESTREPLYBODY{code,integer,required,int64} the HTTP status code, always 200

@RESTREPLYBODY{errorNum,integer,required,int64} the server error number

@RESTREPLYBODY{role,string,required,string} one of [ SINGLE, COORDINATOR, PRIMARY, SECONDARY, AGENT, UNDEFINED]

@endDocuBlock