doc.md

Protocol Documentation

Table of Contents

• api.proto

  • HelloReq

  • HelloResp

  • SayResp

  • SayResp.CallSelfMsg

  • SayResp.DbMsg

  • SayResp.EsMsg

  • SayResp.JrpcMsg

  • SayResp.JrpcMsg.ResultEntry

  • SayResp.JrpcMsg.language

  • App

• Scalar Value Types

Top

api.proto

注意：参数统一采用"_"拼接，比如ClusterName=cluster_name，且如果RPC服务开放了网关，方法为读是GET为写则为POST

HelloReq

Field	Type	Label	Description
Name	string

HelloResp

Field	Type	Label	Description
Content	string

SayResp

Field	Type	Label	Description
Db	SayResp.DbMsg
Es	SayResp.EsMsg
Redis	string
Jrpc	SayResp.JrpcMsg
Client	SayResp.CallSelfMsg
Hbase	bytes	repeated

SayResp.CallSelfMsg

Field	Type	Label	Description
Content	string

SayResp.DbMsg

Field	Type	Label	Description
Id	int64
Name	string

SayResp.EsMsg

Field	Type	Label	Description
ClusterName	string
Status	string
TimedOut	bool
NumberOfNodes	double
NumberOfDataNodes	double
ActivePrimaryShards	double
ActiveShards	double
RelocatingShards	double
InitializingShards	double
UnassignedShards	double
DelayedUnassignedShards	double
NumberOfPendingTasks	double
NumberOfInFlightFetch	double
TaskMaxWaitingInQueue	string
TaskMaxWaitingInQueueMillis	double
ActiveShardsPercent	string
ActiveShardsPercentAsNumber	double

SayResp.JrpcMsg

Field	Type	Label	Description
Jsonrpc	string
Result	SayResp.JrpcMsg.ResultEntry	repeated

SayResp.JrpcMsg.ResultEntry

Field	Type	Label	Description
key	string
value	SayResp.JrpcMsg.language

SayResp.JrpcMsg.language

Field	Type	Label	Description
En	string

App

服务方法

Method Name	Request Type	Response Type	Description
Ping	.google.protobuf.Empty	.google.protobuf.Empty	ping
Say	HelloReq	SayResp	say
CallSelf	HelloReq	HelloResp	call_self

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)