更新时间:2025-11-12 GMT+08:00

在ModelArts Studio(MaaS)管理API Key

操作场景

在使用MaaS时,用户经常需要通过API接口调用模型服务进行数据请求和模型推理等操作。然而,如果API Key管理不当(如密钥丢失或泄露),可能导致未经授权的访问风险,从而影响服务的安全性和稳定性。如何确保API Key的安全管理,防止未授权访问?为了解决这个问题,MaaS平台提供了API Key管理功能,支持对API Key进行创建、编辑、权限管理等操作,确保只有具备有效API Key的用户才能成功调用模型服务,且只有具备相应权限的用户才能管理API Key,同时减少密钥长期暴露的风险。本文介绍如何对API Key进行创建、编辑和删除等操作。

约束限制

  • 数量限制:每个账户最多可同时存在30个有效API Key,超出后需要删除旧API Key才能新建。
  • 不可找回:新建API Key后需立即保存,系统不会存储明文,丢失后无法恢复。
  • 鉴权时效:删除API Key后,基于该Key的接口调用将立即失效。

创建API Key

最多可创建30个密钥。每个密钥仅在创建时显示一次,请确保妥善保存。如果密钥丢失,无法找回,需要重新创建API Key以获取新的访问密钥。

  1. 登录ModelArts Studio(MaaS)控制台,在顶部导航栏中选择目标区域。
  2. 在左侧导航栏,单击“API Key管理”
  3. “API Key管理”页面,单击“创建API Key”,填写标签和描述信息后,单击“确定”

    标签和描述信息在创建完成后,不支持修改。

    表1 创建API Key参数说明

    参数

    说明

    标签

    自定义API Key的标签。标签具有唯一性,不可重复。仅支持大小写英文字母、数字、下划线、中划线,长度范围为1~100个字符。

    描述

    自定义API Key的描述,长度范围为1~100个字符。

  4. “您的API Key对话框,复制密钥并保存至安全位置,然后单击“我已保存,确认关闭”
    图1 保存API Key

    关闭后将无法再次查看密钥。创建成功后,在“API Key管理”页面,可以看到新建的API Key,默认显示API Key的前四位和后四位。

    图2 API Key

编辑API Key

API Key创建后,仅支持修改描述和权限。

  1. 登录ModelArts Studio(MaaS)控制台,在顶部导航栏中选择目标区域。
  2. 在左侧导航栏,单击“API Key管理”
  3. 在目标API Key的“操作”列,单击“编辑”
  4. “编辑API Key”对话框,按需修改描述和权限,然后单击“确定”

    参数说明请参见表1

删除API Key

当API Key数量达到上限,或者API Key发生泄露、遗忘等情况时,建议您及时删除不再使用的API Key。删除后该API Key将无法使用且无法找回。

  1. 登录ModelArts Studio(MaaS)控制台,在顶部导航栏中选择目标区域。
  2. 在左侧导航栏,单击“API Key管理”
  3. “API Key管理”页面右侧,单击API Key右侧的“删除”
  4. “删除API Key”对话框,单击“确定”

常见问题

  1. 创建API Key后需要等待多久才能生效?

    API Key在创建后不会立即生效,通常需要等待几分钟才能生效。

  2. API Key是否支持跨区域使用?

    API Key是区域级别的,不支持跨区域使用。例如,中国-香港区域的API Key必须通过中国-香港控制台创建,且仅能在该区域内调用服务。

相关文档