在ModelArts Studio（MaaS）管理API Key

场景描述

当用户使用MaaS部署的模型服务进行数据请求、模型推理等操作时，系统通过验证API Key来确认用户的身份与访问权限，只有具备有效API Key的用户才能成功调用模型服务，防止未经授权的访问。

• 首次接入服务：用户首次调用模型接口时需要创建API Key完成身份认证。
• 密钥丢失或泄露：原有API Key泄露或遗忘时，需要新建并替换旧密钥以保障安全。
• 定期轮换密钥：根据安全策略定期更新密钥，减少长期暴露的风险。

约束限制

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

前提条件

• 具有API 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. 在“您的密钥”对话框，复制密钥并保存至安全位置。
5. 保存完毕后，单击“关闭”。

   单击“关闭”后将无法再次查看密钥。创建成功后，在“API Key管理”页面，可以看到新建的API Key。

   图1 API Key
   

删除API Key

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

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

常见问题

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

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

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

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