Skip to content

Commit 0227bed

Browse files
committed
Add docs for the API about kicking sessions of a username
1 parent d17964a commit 0227bed

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

en_US/modules/username_quota.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,28 @@ curl -u admin:public 'http://localhost:18083/api/v4/quota/usernames/a' | jq .
117117
"code": 0
118118
}
119119
```
120+
121+
### DELETE /api/v4/quota/usernames/:username
122+
123+
Forcefully disconnect all sessions associated with a specific username.
124+
125+
**Success Response Body (JSON):**
126+
127+
| Name | Type | Description |
128+
| ---- | ------- | ----------- |
129+
| code | Integer | 0 indicates success |
130+
| data | Object | Details of disconnected sessions |
131+
| data.kicked | Integer | Number of disconnected sessions |
132+
133+
**Examples**
134+
135+
```shell
136+
curl -X DELETE -u admin:public 'http://localhost:18083/api/v4/quota/usernames/a' | jq .
137+
138+
{
139+
"data": {
140+
"kicked": 1
141+
},
142+
"code": 0
143+
}
144+
```

zh_CN/modules/username_quota.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ curl -u admin:public 'http://localhost:18083/api/v4/quota/usernames' | jq .
9696
| data.used | Integer | 该用户名的会话数 |
9797
| data.clientids | Array | 包含客户端 ID 的列表 |
9898

99-
**Examples**
99+
**示例**
100100

101101
```shell
102102
curl -u admin:public 'http://localhost:18083/api/v4/quota/usernames/a' | jq .
@@ -112,3 +112,27 @@ curl -u admin:public 'http://localhost:18083/api/v4/quota/usernames/a' | jq .
112112
"code": 0
113113
}
114114
```
115+
116+
### DELETE /api/v4/quota/usernames/:username
117+
118+
强制断开指定用户名下的所有客户端连接。
119+
120+
**成功响应体 (JSON):**
121+
| 名称 | 类型 | 描述 |
122+
| ---- | ------- | ----------- |
123+
| code | Integer | 0 表示成功 |
124+
| data | Object | 断开会话详情 |
125+
| data.kicked | Integer | 被断开的会话数 |
126+
127+
**示例**
128+
129+
```shell
130+
curl -X DELETE -u admin:public 'http://localhost:18083/api/v4/quota/usernames/a' | jq .
131+
132+
{
133+
"data": {
134+
"kicked": 1
135+
},
136+
"code": 0
137+
}
138+
```

0 commit comments

Comments
 (0)