common_standard_header.md

English | 中文

Introduction to Request Common Standard Header

Field	Name	Type	Required	Description
cmd_id	Protocol	uint32	See individual interface definitions for provision
seq_id	Sequence	uint32	Yes	Unique identifier generated by the requester; responses will match the request
trace	Trace	string	Yes	Unique identifier generated by the requester; responses will match the request; Maximum length 64
data	Data	object	Yes	Specific data format see individual interface definitions

{
    "cmd_id":22000,
    "seq_id":123,
    "trace":"asdfsdfa",
    "data":{
    }
}

Introduction to Response Common Standard Header

Field	Name	Type	Description
ret	Return	int32	Error Code Description
msg	Message	string	Description of success or failure
cmd_id	Protocol	uint32	See individual interface definitions for provision
seq_id	Sequence	uint32	Unique identifier generated by the requester; responses will match the request
trace	Trace	string	Unique identifier generated by the requester; responses will match the request; Maximum length 64
data	Data	object	Specific data format see individual interface definitions

{
    "ret":201,
    "msg":"request header param invalid",
    "cmd_id":0,
    "seq_id":0,
    "trace":"",
    "data":{
    }    
}