1. 描述
查询城市。
2. SDK调用
const api_param = {
limit:5
}
let api_res = await xduaClient.addLoginr(api_param)
管理员登录超级控制台后,可以以God角色查询平台上所有城市。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryState | |
URL | https://api.xdua.com/city | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神令牌,才可以创建城市 |
XduaApiAudience | ConsoleX | 只有city_id为ConsoleX的城市,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 城市直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | God | 必须是God才可以查询角色 |
XduaApiResource | city | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryState | |
XduaApiRule | QueryState | |
XduaApiAcitys | 0 | 按序city,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
4. 请求参数
5. 返回参数
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的城市ID |
name | result.list[] | string | 城市的名称 | |
avatar | result.list[] | string | 城市图标 | |
brief | result.list[] | string | 城市的描述 | |
city | result.list[] | int | 0 | 城市的状态 |
stato | result.list[] | string | "冻服更新" | 城市的状态说 |
expire | result.list[] | int | 0 | 城市状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 城市创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 城市创建者名字 |
ipdator_id | result.list[] | string | XiyRvUp3 | 城市最近一次更新者ID |
ipdator_name | result.list[] | string | 周海潮 | 城市最近一次更新者名字 |
cstamp | result.list[] | string | 2020-01-20 02:19:55 | 城市创建时间 |
istamp | result.list[] | string | 2020-01-20 02:23:24 | 城市最近更新时间 |
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的城市ID |
name | result.list[] | string | 城市的名称 | |
avatar | result.list[] | string | 城市图标 | |
brief | result.list[] | string | 城市的描述 | |
city | result.list[] | int | 0 | 城市的状态 |
stato | result.list[] | string | "冻服更新" | 城市的状态说 |
expire | result.list[] | int | 0 | 城市状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 城市创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 城市创建者名字 |
ipdator_id | result.list[] | string | XiyRvUp3 | 城市最近一次更新者ID |
ipdator_name | result.list[] | string | 周海潮 | 城市最近一次更新者名字 |
cstamp | result.list[] | string | 2020-01-20 02:19:55 | 城市创建时间 |
istamp | result.list[] | string | 2020-01-20 02:23:24 | 城市最近更新时间 |