園區(qū)開放接口,查詢租戶的園區(qū)空間列表,appId非必填
路徑 | /campus/paas/openapi/tenant/space/query |
版本號 | 1.0.0 |
協(xié)議 | HTTPS |
請求方法 | POST |
是否需要用戶身份鑒權(quán) | 否 |
超時(shí)時(shí)間 | 10000 |
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
appId | String | 否 | 統(tǒng)一應(yīng)用id | |
pageNo | Int | 是 | 當(dāng)前頁碼 | |
pageSize | Int | 是 | 每頁條數(shù) |
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
響應(yīng)碼, 200: 成功 |
|
message | String |
錯(cuò)誤消息 |
|
localizedMsg | String |
本地語言錯(cuò)誤消息 |
|
data | JSON |
返回結(jié)果數(shù)據(jù) |
|
total | Long |
總條數(shù) |
|
pageNo | Int |
當(dāng)前頁碼 |
|
pageSize | Int |
每頁條數(shù) |
|
data | JSON |
結(jié)果集合 |
|
name | String |
空間名稱 |
|
namePath | String |
空間層級結(jié)構(gòu) |
|
usesName | String |
空間用途名稱 |
|
hasChild | Boolean |
是否含有子空間 |
|
description | String |
空間描述 |
|
spaceId | String |
空間id |
|
usesCode | String |
空間用途code |
|
path | String |
空間層級關(guān)系 |
示例
請求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"appId": "value0",
"pageNo": "value1",
"pageSize": "value2"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"data":[
{
"description": "",
"hasChild": true,
"name": "xxxxxxxxxx",
"namePath": "/xxxxxxxxxx/xxxxxxxxxx/",
"usesName": "寫字樓",
"spaceId": "xxxxxx",
"usageCode": "xxxxxx"
},
{
"description": "",
"hasChild": false,
"name": "xxxxxxxxxx",
"namePath": "/xxxxxxxxxx/xxxxxxxxxx/xxxxxxxxxx/",
"usesName": "寫字樓",
"spaceId": "xxxxxx",
"usageCode": "xxxxxx"
}
],
"pageNo": 1,
"pageSize": 20,
"total": 100
}
}
異常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "請求被禁止",
"data": null
}
錯(cuò)誤碼
HttpCode | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 2402 | iotToken not exist | iottoken不存在 |
200 | 2401 | refreshToken invalid | refreshToken已經(jīng)失效 |
200 | 460 | identityIds need between 1-50 | 入?yún)㈠e(cuò)誤 |
200 | 403 | request forbidden. | 請求被禁止 |
200 | 403 | request forbidden. | 請求被禁止 |
200 | 403 | request forbidden. | 請求被禁止 |
200 | 403 | request forbidden | 請求被禁止 |