Skip to content

查询所有API Key ​

接口路径 ​

http
GET /api/open/token/search

配额计算说明 ​

配额字段为内部额度单位,换算成金额(人民币)的方式:

金额(¥) = quota ÷ quota_per_unit × usd_exchange_rate

其中:

  • quota:来自本接口返回的 data[].remain_quota(剩余)或 data[].used_quota(已用);月度相关可用 data[].monthly_quota_limit、data[].current_month_used
  • quota_per_unit、usd_exchange_rate、quota_display_type:来自 查询换算参数 接口(GET /api/open/status)

若 quota_display_type = USD(美元),则去掉 × usd_exchange_rate。

当 unlimited_quota = true 时,令牌额度不受限,不必用 remain_quota 换算「剩余余额」。

请求参数 ​

字段类型是否必传说明限制条件备注
pint否页码默认 1示例: 1
page_sizeint否每页条数默认 10,最大 5000示例: 20
sizeint否每页条数(别名)与 page_size 同义优先级低于 page_size
psint否每页条数(别名)与 page_size 同义优先级低于 page_size
keywordstring否Token 名称关键字模糊匹配 name示例: api-key
tokenstring否密钥片段模糊匹配 key;会自动去掉前缀 sk-示例: abc123
statusstring否Token 状态见下文状态枚举表示例: 1
groupstring否分组名称匹配 group 或 groups JSON示例: default
enterprise_idint否企业 ID查询企业下信息必传,不传则按照个人模式查询示例: 1001
scopestring否查询范围见下文 Scope 枚举表;默认 mine示例: organization
organization_idint否部门 ID企业模式;指定查询哪个部门示例: 2001
user_idint否用户 ID 过滤按拥有者用户筛选示例: 100

请求示例 ​

JSON
GET 'https://neolink.com/backend/api/open/token/search?keyword=prod&status=1&scope=organization&organization_id=2001&p=1&page_size=20'
GET 'https://neolink.com/backend/api/open/token/search?token=abc1&scope=mine'
GET 'https://neolink.com/backend/api/open/token/search?group=default&scope=all&user_id=100'

返回信息 ​

字段类型是否必传说明备注
successbool是请求是否成功固定值
messagestring是错误提示信息(成功时为空)固定值
data[]Token是Token 列表详见下表
totalint是总记录数满足条件的 Token 总数

Token 对象字段说明

字段类型是否必传说明备注
idint是Token 记录 ID数据库唯一标识
namestring是Token 名称自定义名称
keystring是密钥显示值仅显示后4位
statusint是Token 状态1=正常;2=禁用;3=已过期;4=预算不足
created_timeint64是创建时间Unix 秒级时间戳
accessed_timeint64否最后访问时间Unix 秒级时间戳;未访问过则为 0
expired_timeint64是过期时间Unix 秒级时间戳;-1=永不过期
remain_quotaint64是剩余配额当前可用配额;换算见上文「配额计算说明」
used_quotaint64是已用配额已消耗配额;换算见上文「配额计算说明」
unlimited_quotabool是是否无限配额true=不受限;false=受限
user_idint是所属用户 ID创建者用户 ID
enterprise_idint是企业 ID所属企业
organization_idint是组织 ID所属部门
busi_typeint是业务类型1=API;2=其他
groupstring是主分组默认分组名
groups[]string是分组数组所属的全部分组
model_limitsstring是模型限制逗号分隔模型列表
model_limits_enabledbool是模型限制是否启用true=启用;false=不启用
allow_ipsstring是IP 白名单逗号分隔 IP 或 CIDR
monthly_quota_limitint64是月配额上限当月最高配额限制
current_monthint是当前月份格式 YYYYMM
current_month_usedint64是当月已用当月消耗配额
cross_group_retrybool是跨分组重试true=启用;false=禁用
created_by_member_idint是创建人成员 ID企业内创建者的成员ID
member_display_namestring是创建人显示名真名或昵称
member_usernamestring是创建人用户名登录用户名
member_mobile_maskedstring是创建人手机号(掩码)仅显示后4位
creator_deletedbool是创建人是否已删除true=已删除;false=正常

返回示例 ​

JSON
成功响应
{
  "success": true,
  "message": "",
  "data": [
    {
      "id": 5001,
      "name": "api-key-prod-1",
      "key": "sk-a5b0",
      "status": 1,
      "created_time": 1711468800,
      "accessed_time": 1711584000,
      "expired_time": -1,
      "remain_quota": 1000000,
      "used_quota": 500000,
      "unlimited_quota": false,
      "user_id": 100,
      "enterprise_id": 1001,
      "organization_id": 2001,
      "busi_type": 1,
      "group": "default",
      "groups": ["default", "premium"],
      "groups_meta": [
        {
          "name": "default",
          "ratio": "1",
          "desc": "默认分组"
        },
        {
          "name": "premium",
          "ratio": "1.5",
          "desc": "高级分组"
        }
      ],
      "model_limits": "gpt-4,gpt-3.5-turbo",
      "model_limits_enabled": true,
      "allow_ips": "10.0.0.1,192.168.1.0/24",
      "monthly_quota_limit": 2000000,
      "current_month": 202607,
      "current_month_used": 300000,
      "cross_group_retry": true,
      "created_by_member_id": 101,
      "member_display_name": "张三",
      "member_username": "zhangsan",
      "member_mobile_masked": "1385678",
      "creator_deleted": false
    }
  ],
  "total": 156
}
错误响应
{
  "success": false,
  "message": "status 仅支持 1(正常)、2(禁用)、3(已过期) 或 4(预算不足)"
}