文档首页/ 魔坊（ModelArts）模型训推平台/ API参考/ 模型推理（新版）/ 应用密钥管理/ 查询应用密钥 - ListV2ApiKeys
更新时间：2026-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询应用密钥 - ListV2ApiKeys

功能介绍

本接口用于查询当前系统中的apikey列表，适用于管理员或用户需要查看和管理apikey的场景。调用此接口前，确保已具备相应的查询权限。返回的列表将包含每个apikey的基本信息，如apikey值、创建时间、绑定的服务等。如果当前系统中没有apikey，将返回空列表或相应的异常信息，提示用户检查查询条件。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts::listApiKey

    List

    -

    -

    modelarts:apiKey:list

    -

URI

GET /v2/{project_id}/services/api-keys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及。

取值范围：

账号的项目ID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

scope

否

String

参数解释：

生效范围，枚举值，可选值为USER、SERVICE。

约束限制：

不涉及。

取值范围：

  • USER：表示生效范围为用户级别，可以访问该用户创建的所有在线服务。

  • SERVICE：表示生效范围为单个服务，可以访问绑定该api-key的在线服务。

默认取值：

不涉及。

service_id

否

String

参数解释：

服务ID，在创建服务时即可在返回体中获取，也可通过查询服务列表获取当前用户拥有的服务，其中service_id字段即为服务ID。

约束限制：

不涉及。

取值范围：

服务ID。

默认取值：

不涉及。

name

否

String

参数解释：

apikey_name，通过查询api-keys列表获取当前用户拥有的apikey，其中name字段即为apikey_name。

约束限制：

不涉及。

取值范围：

apikey_name。

默认取值：

不涉及。

service_name

否

String

参数解释：

服务名，用户在创建服务时自定义。

约束限制：

服务名称不能重复。

取值范围：

支持1-128个字符，可以包含字母、汉字、数字、连字符和下划线。

默认取值：

不涉及。

key_id

否

String

参数解释：

apikey_id，在创建API_KEY时即可在返回体中获取，也可通过查询api-keys列表获取当前用户拥有的apikey，其中key_id字段即为apikey_id。

约束限制：

不涉及。

取值范围：

apikey_id只能由英文小写字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

limit

否

Integer

参数解释：

指定返回的最大条目数。

约束限制：

不涉及。

取值范围：

[1,500]

默认取值：

10。

offset

否

Integer

参数解释：

分页列表查询的偏移量。

约束限制：

offset必须是limit的整数倍。

取值范围：

不涉及。

默认取值：

0。

workspace_id

否

String

参数解释：

工作空间ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

with_user_scope

否

Boolean

参数解释：

是否查询鉴权范围为USER类型的API KEY，当同时指定service_id时可查询该服务所有可访问的API KEY。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

false。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及。

取值范围：

  • application/json。

  • application/json;charset=utf-8。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

Array of ApiKeyResponseV2 objects

参数解释：

api-key数据。

current

Integer

参数解释：

当前页码，从0开始计数

取值范围：

不涉及。

pages

Integer

参数解释：

总页数，根据传入的limit字段和数据总条数计算得出。如总记录条数为10，limit（单页最大条目数）为3，则页数为4

取值范围：

不涉及。

size

Integer

参数解释：

当前页数量

取值范围：

不涉及。

total

Integer

参数解释：

总记录条数。

取值范围：

不涉及。
表5 ApiKeyResponseV2

参数

参数类型

描述

key_id

String

参数解释：

api-key的ID，在创建API_KEY时即可在返回体中获取，也可通过查询api-keys列表获取当前用户拥有的api-key，其中id字段即为api-key的ID。

取值范围：

UUID格式。

name

String

参数解释：

api-key的名称，在创建API_KEY时自定义。

取值范围：

支持1-64个字符，可以包含字母、汉字、数字、连字符和下划线。

description

String

参数解释：

api-key的描述，在创建API_KEY时自定义。

取值范围：

支持1-256个字符，可以包含字母、汉字、数字、连字符和下划线。

create_time

String

参数解释：

api-key的创建时间，根据创建时的当前时间自动生成。

取值范围：

毫秒级时间戳，13位数字，如1609459200000。

scope

String

参数解释：

api-key生效范围。

取值范围：

  • USER：表示生效范围为用户级别，可以访问该用户创建的所有在线服务。

  • SERVICE：表示生效范围为单个服务，可以访问绑定该api-key的在线服务。

domain_id

String

参数解释：

用户domain ID。获取方法请参见获取账号名和账号ID。

取值范围：

账号ID。

project_id

String

参数解释：

用户项目ID。获取方法请参见](modelarts_03_0147.xml)。

取值范围：

账号的项目ID。

services

Array of ServiceIdName objects

参数解释：

绑定此api-key的在线服务列表。

workspace_id

String

参数解释：

工作空间ID。

取值范围：

工作空间ID。
表6 ServiceIdName

参数

参数类型

描述

id

String

参数解释：

服务ID。

取值范围：

服务ID。

name

String

参数解释：

服务名。

取值范围：

支持1-128个字符，可以包含字母、汉字、数字、连字符和下划线。

请求示例

查询api-keys列表。

GET https://{endpoint}/v2/{project_id}/services/api-keys

响应示例

状态码：200

查询api-keys列表成功

{
  "current" : 0,
  "data" : [ {
    "create_time" : 1743494875405,
    "description" : "test",
    "domain_id" : "04f258c83e00d5****example",
    "key_id" : "8a0e847095f063aa0****example",
    "name" : "api-keys-name-test",
    "project_id" : "04f258c84780d5a52f3****example",
    "scope" : "SERVICE",
    "services" : [ ]
  }, {
    "create_time" : 1743228962325,
    "description" : "test",
    "domain_id" : "04f258c83e00d5a50f38c****example",
    "key_id" : "8a0e4a2d95e088ea0195e0****example",
    "name" : "test",
    "project_id" : "04f258c84780d5a52f3bc****example",
    "scope" : "SERVICE",
    "services" : [ ]
  }, {
    "create_time" : 1743228957659,
    "description" : "test",
    "domain_id" : "04f258c83e00d5a****example",
    "key_id" : "8a0e4a2d95e088ea01****example",
    "name" : "test123123",
    "project_id" : "04f258c84780d5a****example",
    "scope" : "SERVICE",
    "services" : [ ]
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 3
}

状态码

状态码

描述

200

查询api-keys列表成功

错误码

请参见错误码。

父主题： 应用密钥管理