订单中心-订单服务-统计服务接口文档

接口

1. 接口定义

1.1. 统计服务

1.1.1. 提交count

POST /{tenant_id}/soms/countservice/count

1.1.1.1. 说明

提交count

1.1.1.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Query	operator 必填	操作人	string
Body	count 必填	统计	Count

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

count
必填

统计

Count

1.1.1.3. 响应

HTTP代码	说明	类型
200	successful operation	ActionResult

HTTP代码

说明

类型

200

successful operation

ActionResult

1.1.1.4. HTTP请求示例

请求 path

/string/soms/countservice/count?operator=string

请求 body

{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "type" : "order",
  "action" : "decrypt",
  "value" : "10",
  "business_key" : "123",
  "action_name" : "解密"
}

1.1.1.5. HTTP响应示例

响应 200

{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.2. 查询统计

POST /{tenant_id}/soms/countservice/count/query

1.1.2.1. 说明

查询统计

1.1.2.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Query	desc 必填	是否倒序	boolean
Query	page 必填	页码	integer (int32)
Query	page_size 必填	分页大小 [1, 1000]	integer (int32)
Query	sort_key 可选	排序字段	string
Body	filter 必填	查询条件	统计服务过滤器

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小 [1, 1000]

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

查询条件

统计服务过滤器

1.1.2.3. 响应

HTTP代码	说明	类型
200	successful operation	soms分页查询结果Count

HTTP代码

说明

类型

200

successful operation

soms分页查询结果Count

1.1.2.4. HTTP请求示例

请求 path

/string/soms/countservice/count/query?desc=true&page=0&page_size=0

请求 body

{
  "typeEq" : "order",
  "typeIn" : "[\"order\"]",
  "businessKeyEq" : "123",
  "businessKeyIn" : "[\"123\",\"456\"]",
  "actionEq" : "decrypt",
  "actionIn" : "[\"decrypt\"]",
  "actionNameLike" : "string",
  "modifiedBegin" : "2021-08-23 12:16:20",
  "modifiedEnd" : "2021-08-23 12:16:20"
}

1.1.2.5. HTTP响应示例

响应 200

{
  "page" : 0,
  "pageSize" : 100,
  "pageCount" : 2,
  "total" : "1000L",
  "data" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "type" : "order",
    "action" : "decrypt",
    "value" : "10",
    "business_key" : "123",
    "action_name" : "解密"
  } ]
}

1.1.3. 获取count

GET /{tenant_id}/soms/countservice/count/{business_key}

1.1.3.1. 说明

获取count

1.1.3.2. 参数

类型	名称	说明	类型
Path	business_key 必填	业务key	string
Path	tenant_id 必填	租户ID	string
Query	action 必填	操作类型	string
Query	type 必填	类型	string

类型

名称

说明

类型

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户ID

string

Query

action
必填

操作类型

string

Query

type
必填

类型

string

1.1.3.3. 响应

HTTP代码	说明	类型
200	successful operation	Count

HTTP代码

说明

类型

200

successful operation

Count

1.1.3.4. HTTP请求示例

请求 path

/string/soms/countservice/count/string?action=string&type=string

1.1.3.5. HTTP响应示例

响应 200

{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "type" : "order",
  "action" : "decrypt",
  "value" : "10",
  "business_key" : "123",
  "action_name" : "解密"
}

1.1.4. 计数加1

POST /{tenant_id}/soms/countservice/count/{business_key}/add

1.1.4.1. 说明

计数加1

1.1.4.2. 参数

类型	名称	说明	类型
Path	business_key 必填	业务key	string
Path	tenant_id 必填	租户Id	string
Query	action 必填	操作类型	string
Query	operator 可选		string
Query	type 必填	类型	string

类型

名称

说明

类型

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户Id

string

Query

action
必填

操作类型

string

Query

operator
可选

string

Query

type
必填

类型

string

1.1.4.3. 响应

HTTP代码	说明	类型
200	successful operation	ActionResult

HTTP代码

说明

类型

200

successful operation

ActionResult

1.1.4.4. HTTP请求示例

请求 path

/string/soms/countservice/count/string/add?action=string&type=string

1.1.4.5. HTTP响应示例

响应 200

{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

2. 定义

2.1. ActionResult

名称说明类型

名称	说明	类型
code 可选	样例 : `"string"`	string
message 可选	样例 : `"string"`	string
success 可选	默认值 : `false` 样例 : `true`	boolean

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. Count

名称说明类型

名称	说明	类型
action 可选	action 样例 : `"decrypt"`	string
action_name 可选	actionName 样例 : `"解密"`	string
business_key 可选	业务key 样例 : `"123"`	string
created 可选	样例 : `"2020-06-17 10:00:00"`	string (date-time)
creator 可选	样例 : `"string"`	string
modified 可选	样例 : `"2020-06-17 10:00:00"`	string (date-time)
modifier 可选	样例 : `"string"`	string
type 可选	类型样例 : `"order"`	string
value 可选	value 样例 : `"10"`	string

action
可选

action
样例 : "decrypt"

string

action_name
可选

actionName
样例 : "解密"

string

business_key
可选

业务key
样例 : "123"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

type
可选

类型
样例 : "order"

string

value
可选

value
样例 : "10"

string

2.3. soms分页查询结果Count

名称说明类型

名称	说明	类型
data 可选	数据样例 : `[ "Count" ]`	< Count > array
page 可选	页码样例 : `0`	integer (int32)
pageCount 可选	页数样例 : `2`	integer (int32)
pageSize 可选	页面大小样例 : `100`	integer (int32)
total 可选	总数样例 : `"1000L"`	integer (int64)

data
可选

数据
样例 : [ "Count" ]

< Count > array

page
可选

页码
样例 : 0

integer (int32)

pageCount
可选

页数
样例 : 2

integer (int32)

pageSize
可选

页面大小
样例 : 100

integer (int32)

total
可选

总数
样例 : "1000L"

integer (int64)

2.4. 统计服务过滤器

名称说明类型

名称	说明	类型
actionEq 可选	action 样例 : `"decrypt"`	string
actionIn 可选	action在……之中样例 : `"[\"decrypt\"]"`	< string > array
actionNameLike 可选	actionName 样例 : `"string"`	string
businessKeyEq 可选	业务key 样例 : `"123"`	string
businessKeyIn 可选	业务key在……之中样例 : `"[\"123\",\"456\"]"`	< string > array
modifiedBegin 可选	最后修改时间起始于样例 : `"2021-08-23 12:16:20"`	string (date-time)
modifiedEnd 可选	最后修改时间结束于样例 : `"2021-08-23 12:16:20"`	string (date-time)
typeEq 可选	类型样例 : `"order"`	string
typeIn 可选	类型在……之中样例 : `"[\"order\"]"`	< string > array

actionEq
可选

action
样例 : "decrypt"

string

actionIn
可选

action在……之中
样例 : "[\"decrypt\"]"

< string > array

actionNameLike
可选

actionName
样例 : "string"

string

businessKeyEq
可选

业务key
样例 : "123"

string

businessKeyIn
可选

业务key在……之中
样例 : "[\"123\",\"456\"]"

< string > array

modifiedBegin
可选

最后修改时间起始于
样例 : "2021-08-23 12:16:20"

string (date-time)

modifiedEnd
可选

最后修改时间结束于
样例 : "2021-08-23 12:16:20"

string (date-time)

typeEq
可选

类型
样例 : "order"

string

typeIn
可选

类型在……之中
样例 : "[\"order\"]"

< string > array