API密钥列表

方法概览

项目	内容
文档类型	PHP 类方法
方法标识	`app\common\model\ApiModel::apiList`
所属业务	开放接口
来源模块/系统	API密钥模型

功能说明

API密钥列表

调用示例

$param = ['page' => 1, 'limit' => 1, 'orderby' => 'id', 'sort' => 'string'];
$result = (new \app\common\model\ApiModel())->apiList($param);

参数

参数	类型	必填	默认值	校验规则	说明
`param.page`	`int`	否	—	—	页数
`param.limit`	`int`	否	—	—	每页条数
`param.orderby`	`string`	否	—	—	排序 id
`param.sort`	`string`	否	—	—	升/降序 asc,desc

返回值

返回项	类型	说明
`list`	`array`	API密钥
`list[].name`	`int`	API密钥名称
`list[].id`	`int`	API密钥ID
`list[].token`	`string`	token
`list[].create_time`	`int`	创建时间
`list[].status`	`string`	白名单状态0关闭1开启
`list[].ip`	`string`	白名单IP
`count`	`int`	API日志总数
`create_api`	`int`	是否可创建API:0否1是

正常返回

{
  "list": [
    {
      "name": 1,
      "id": 1,
      "token": "example-token",
      "create_time": 1752984000,
      "status": "1",
      "ip": "192.0.2.1"
    }
  ],
  "count": 1,
  "create_api": 1
}

异常情况

异常类型	说明
`Throwable`	调用失败时由具体实现抛出异常，异常信息以运行时结果为准。

本页目录