客户管理/获取客户树
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/modelRouter/open/clients/tree HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| maxResults |
integer |
否 |
maxResults |
10 |
| nextToken |
string |
否 |
nextToken |
xxxx-xxx-xxxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
OpenApiResponse<List |
{ "success": true, "data": { "id": 1, "name": "总公司", "client_uuid": "st-xxxx", "level": 1, "parent_id": null, "main": 0, "children": [ { "id": 2, "name": "分公司1", "client_uuid": "st-yyyy", "level": 2, "parent_id": 1, "main": 1, "children": [] } ] }, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" } |
|
| requestId |
string |
请求编号 |
xxxx-xxxx-xxxx-xxxxxxxx |
| success |
boolean |
是否成功 |
true |
| errCode |
string |
错误信息编码 |
UNKNOWN_ERROR |
| errMessage |
string |
错误信息 |
未知错误 |
| httpStatusCode |
integer |
http 状态码 |
200 |
| data |
array |
返回数据。客户树形结构列表 |
|
|
ClientTreeDTO |
是否删除成功 |
[] |
|
| nextToken |
string |
nextToken |
xxxx-xxx-xxxxx |
| maxResults |
integer |
maxResults |
10 |
示例
正常返回示例
JSON格式
{
"requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
"success": true,
"errCode": "UNKNOWN_ERROR",
"errMessage": "未知错误",
"httpStatusCode": 200,
"data": [
{
"id": 1,
"name": "我的客户",
"address": "杭州市",
"contact": "13800138000",
"main": 0,
"remark": "备注",
"clientUuid": "st-xxxx",
"allowedModels": "1,2,3",
"discount": 1,
"deleteTag": 0,
"level": 1,
"parentId": 0,
"gmtCreate": "2024-01-01T00:00:00Z",
"gmtModified": "2024-01-01T00:00:00Z",
"children": [
{
"id": 1,
"name": "我的客户",
"address": "杭州市",
"contact": "13800138000",
"main": 0,
"remark": "备注",
"clientUuid": "st-xxxx",
"allowedModels": "1,2,3",
"discount": 1,
"deleteTag": 0,
"level": 1,
"parentId": 0,
"gmtCreate": "2024-01-01T00:00:00Z",
"gmtModified": "2024-01-01T00:00:00Z",
"children": [
{
"id": 1,
"name": "我的客户",
"address": "杭州市",
"contact": "13800138000",
"main": 0,
"remark": "备注",
"clientUuid": "st-xxxx",
"allowedModels": "1,2,3",
"discount": 1,
"deleteTag": 0,
"level": 1,
"parentId": 0,
"gmtCreate": "2024-01-01T00:00:00Z",
"gmtModified": "2024-01-01T00:00:00Z",
"children": []
}
]
}
]
}
],
"nextToken": "xxxx-xxx-xxxxx",
"maxResults": 10
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | Server.Internal.UnknownError | The request processing has failed due to some unknown error. | |
| 403 | B.Permission.DeniedException | 鉴权失败或权限不足 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。