文档首页/ MaaS模型即服务/ API参考/ API Key鉴权管理/ 查询API Key列表
更新时间：2026-10-27 GMT+08:00
查看PDF
分享

查询API Key列表

功能介绍

查询接口为API Key的资产盘点与安全审计提供了全局视野。通过该接口，管理员可以获取当前账户下所有密钥的列表及其详细元数据，包括创建时间、来源、权限范围及当前状态等。

接口约束:

  • 鉴权：调用本接口需在请求头携带有效 IAM token（X-Auth-Token），并具备对应细粒度权限：查询需modelarts:apiKey:list。

  • 仅返回未删除的记录；不返回api_key明文，仅返回脱敏后的mask字符串。

URI

GET /v2/{project_id}/maas/api-auth/api-keys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：项目ID，是华为云中用于标识租户资源的唯一编号，与具体的区域（Region）相关联。在调用华为云API时用于定位资源所属的项目空间。可通过获取项目ID和名称接口获取。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：偏移量。

约束限制：大于等于0。

取值范围：大于等于0。

默认取值：0。

limit

否

Integer

参数解释：每页的数量限制。

约束限制：最小为1。

取值范围：大于等于1的整数。

默认取值：30。

order

否

String

参数解释：API Key列表的排序规则。

约束限制：不涉及。

取值范围：

  • desc：降序。

  • asc：升序。

默认取值：desc。

sort_by

否

String

参数解释：默认用来排序的字段。

约束限制：不涉及。

取值范围：数据存在的字段。

默认取值：create_at。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

api_key_list

ListApiKeysRespPage object

参数解释：查询出来当前分页的API Keys。

取值范围：不涉及。

user_api_key_quota

Integer

参数解释：ApiKey的最大创建数量。

取值范围：正整数。
表4 ListApiKeysRespPage

参数

参数类型

描述

items

Array of ApiKeyInfo objects

参数解释：查询出来当前存在的所有API Keys。

取值范围：不涉及。

total

Integer

参数解释：API Key的总数。

取值范围：大于等于0的整数。

count

Integer

参数解释：当前页的数量。

取值范围：大于0的整数。

default_sort_by

String

参数解释：默认用来排序的字段。

取值范围：空。

default_order

String

参数解释：排序是升序还是降序。

取值范围：

  • desc：降序。

  • asc：升序。
表5 ApiKeyInfo

参数

参数类型

描述

id

String

参数解释：API Key的唯一标识ID。

取值范围：不涉及。

api_key

String

参数解释：脱敏后的鉴权信息，经SHA256加密存储。

取值范围：不涉及。

label

String

参数解释：API Key标签。

取值范围：标签长度范围为 0 到 100 个字符，支持大小写英文字母、数字、下划线、中划线。

description

String

参数解释：API Key 的描述信息。

取值范围：最大长度100 字符。

mask

String

参数解释：脱敏后的鉴权信息。

取值范围：不涉及。

allow_all

Boolean

参数解释：是否允许访问所有资源，true为允许，false为不允许。

取值范围：

  • true：允许访问所有资源。

  • false：不允许访问所有资源。

ip_whitelist

Array of strings

参数解释：API Key的IP白名单是华为云MaaS（模型即服务）中API Key的一项安全功能，用于限制只有指定IP地址才能使用该API Key调用模型服务，防止API Key泄露后被非法利用。

取值格式：

  • 单个IP地址(如：192.168.1.1)；

  • IP地址段范围(如：192.168.1.10-192.168.1.100)；

  • CIDR网段(如：192.168.10.0/24)。

IP校验规则：IP 单段数值校验：IPv4 的每一个段（Octet）必须是 0 到 255 之间的有效十进制整数。

IP 格式与子网掩码校验：

  • 整体格式必须符合 x.x.x.x 或 x.x.x.x/y 的正则规范。

  • 若包含子网掩码，其数值必须在 0 到 32 之间。

特殊业务规则：子网掩码的位数必须大于或等于该 IP 地址转换为 32 位二进制后最后一个 1 所在的位置（即掩码不能截断 IP 的有效标识位）。

IP 大小比较规则：比较两个 IP 时，按从左到右（高位到低位）逐段进行数值比对，以此确定大小关系。

IP 范围校验：一个合法的 IP 范围必须严格包含 2 个 IP，且这两个 IP 均需通过上述的格式与掩码校验，同时起始 IP 必须小于或等于结束 IP。

resident_model_version_whitelist

ResidentModelVersionWhitelist object

参数解释：常驻模型版本白名单，限制可访问的常驻模型版本。

endpoint_whitelist

EndpointWhitelist object

参数解释：自定义接入点白名单，限制可访问的自定义接入点。

create_at

Integer

参数解释：API Key的创建时间，时间戳格式，单位毫秒，示例：1773065452790。

取值范围：不涉及。

channel

String

参数解释：渠道，分maas和渠道专属API Key。

取值范围：

  • maas：默认是maas的渠道创建。

  • codearts：专属渠道创建。
表6 ResidentModelVersionWhitelist

参数

参数类型

描述

overall

String

参数解释：API Key生效的模型服务范围（包括模型服务以及对应的版本）。

取值范围：

  1. all: 表示全部生效。

  2. 空字符串：表示非全部生效。

whitelist

Array of Whitelist objects

参数解释：常驻模型版本白名单列表，逐条指定可访问的常驻模型及其版本。

取值范围：Whitelist对象数组，见下方拆解字段。
表7 Whitelist

参数

参数类型

描述

resident_model_id

String

参数解释：常驻模型ID。以Chrome浏览器为例，获取常驻模型ID操作如下：

在MaaS控制台的“在线推理-预置服务”页面，使用快捷键F12打开开发者工具，选择“Network”页签，搜索“query”，单击以“query?business_type=payment”开头的名称，在“Response”页签中，按需搜索模型名称，例如搜索DeepSeek-V4.1-Flash，resident_model_id参数值即为常驻模型ID。

取值范围：不涉及。

version_whitelist

String

参数解释：该常驻模型允许访问的版本白名单，多个版本以逗号分隔。以Chrome浏览器为例，获取常驻模型版本名称操作如下：

在MaaS控制台的“在线推理-预置服务”页面，使用快捷键F12打开开发者工具，选择“Network”页签，搜索“query”，单击以“query?business_type=payment”开头的名称，在“Response”页签中，按需搜索模型名称，例如搜索DeepSeek-V4.1-Flash，version_list下对应version_name为DeepSeek-V4.1-Flash的那条数据的id即为常驻模型版本值。

取值范围：不涉及。
表8 EndpointWhitelist

参数

参数类型

描述

overall

String

参数解释：整体放行策略。

取值范围：“all” 表示放行全部，空字符串表示不启用整体放行。

whitelist

Array of strings

参数解释：自定义接入点ID白名单列表，仅允许列表内的自定义接入点被访问。可通过查询自定义接入点接口获取ID。

请求示例

GET https://{endpoint}/v2/{project_id}/maas/api-auth/api-keys?offset=0&limit=30&order=desc&sort_by=create_at

响应示例

状态码：200

{
  "user_api_key_quota" : 30,
  "api_key_list" : {
    "total" : 19,
    "count" : 10,
    "default_order" : "desc",
    "items" : [ {
      "id" : "145528d0-5afe-468e-80ad-e1091e323fdf",
      "label" : "xsxs",
      "description" : "xsxs",
      "create_at" : 1773065452790,
      "mask" : "pL2v******AhoQ",
      "allow_all" : true,
      "ip_whitelist" : [ ],
      "resident_model_version_whitelist" : {
        "overall" : "",
        "whitelist" : [ {
          "resident_model_id" : "ce15e584-bb43-46ff-a215-febb27501353",
          "version_whitelist" : "all"
        }, {
          "resident_model_id" : "1a848aa4-6493-4da0-bd5a-e1e918fad55f",
          "version_whitelist" : "all"
        } ]
      },
      "endpoint_whitelist" : {
        "overall" : "",
        "whitelist" : [ "d8d76767-637a-4040-8835-39bdc39b79b6", "6a9cba80-3594-4611-a8c0-a5a1fd34985d" ]
      },
      "channel" : "maas"
    }, {
      "id" : "6d088782-609a-4db5-b7c8-a7028858c0c7",
      "label" : "asdfasd",
      "description" : "asfdasdf",
      "create_at" : 1787911404440,
      "mask" : "Q-Kw******KsOg",
      "allow_all" : true,
      "ip_whitelist" : [ ],
      "resident_model_version_whitelist" : {
        "overall" : "",
        "whitelist" : null
      },
      "endpoint_whitelist" : {
        "overall" : "",
        "whitelist" : null
      },
      "channel" : "maas"
    } ]
  }
}

状态码

状态码

描述

200

获取API Key鉴权信息列表成功。

错误码

请参见错误码。

父主题： API Key鉴权管理