管理api key-j9九游会登录
在使用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操作权限。关于iam子用户的api key权限管理,请参见管理子用户的api key操作权限。
创建api key
最多可创建30个api key。api key仅会在新建后显示一次,请及时复制并妥善保存。如果密钥丢失,请新建api key。
- 登录,在顶部导航栏中选择目标区域。
- 在左侧导航栏,选择 。
- 在“api key管理”页面,单击“创建api key”,配置基础信息和权限设置,单击“创建”。
标签在创建完成后,不支持修改。
表1 创建api key参数说明 参数
说明
基础信息
标签
自定义api key的标签。标签具有唯一性,不可重复。仅支持大小写英文字母、数字、下划线、中划线,长度范围为1~100个字符。
描述
自定义api key的描述,长度范围为1~100个字符。
权限设置
权限范围
支持选择“全部(访问所有资源不受限)”或“自定义(指定访问资源范围)”。默认为“全部(访问所有资源不受限)”。
ip 调用白名单
当“权限范围”选择“自定义(指定访问资源范围)”时,可配置此参数。
开启后,仅白名单中的ip地址可调用模型服务。支持ipv4网段,输入后按enter生效,支持输入100个地址。ipv4格式示例:- 192.168.1.1
- 192.168.1.10-192.168.1.100
- 192.168.10.0/24
图1 ip调用白名单
模型服务访问范围
当“权限范围”选择“自定义(指定访问资源范围)”时,可配置此参数。
支持选择“预置服务”或“自定义接入点”。
- 预置服务:使用该api key通过model参数发起调用时,仅支持访问已勾选的模型及版本。默认“全选”,即选择全部预置服务及版本,包括后续新增预置服务及版本,您也可以按需选择。
- 自定义接入点:默认“全选”,即选择全部自定义接入点,包括后续新增自定义接入点,您也可以按需选择。关于如何创建自定义接入点,请参见创建自定义接入点。
- 在“您的api key”对话框,仔细阅读提示信息,复制密钥并保存至安全位置,然后单击“我已保存,确认关闭”。
图2 保存api key
关闭后将无法再次查看密钥。创建成功后,在“api key管理”页面,可以看到新建的api key,默认显示api key的前四位和后四位。
图3 api key
编辑api key
api key创建后,不支持修改标签,其他配置可按需修改。修改权限可能导致当前部分模型服务、自定义接入点等鉴权失败,请确认业务影响后再操作。
- 登录,在顶部导航栏中选择目标区域。
- 在左侧导航栏,选择 。
- 在目标api key的“操作”列,单击“编辑”。
- 在“编辑api key”对话框,按需修改基础信息和权限设置,然后单击“确定”。
参数说明请参见表1。
- 在“确定编辑api key”对话框,输入yes,单击“确定”。
api key修改后,预计五分钟后生效。
管理子用户的api key操作权限
当管理员未配置iam子用户的api key操作权限时,maas将按照modelarts控制台的“严格授权模式”开关,判断子用户是否具有api key的管理权限。
查看或修改“严格授权模式”开关的步骤如下:
- 管理员登录,按照版本选择以下操作。
- 新版本:在左侧导航栏选择。
- 旧版本:在左侧导航栏选择“全局配置”。
- 在页面中按需打开或关闭“严格授权模式”。
- 打开严格授权模式:未配置api key操作权限的iam子用户,不具有api key的管理权限。关于配置iam子用户的api key操作权限的步骤,请参见下文。
- 关闭严格授权模式:未配置api key操作权限的iam子用户,具有api key的管理权限。
图4 严格授权模式开关
当管理员通过iam控制台配置iam子用户的api key操作权限时,maas将按照管理员的权限配置和modelarts控制台的“严格授权模式”开关,判断子用户是否具有api key的管理权限。
配置iam子用户的api key操作权限的步骤如下:
- 创建自定义策略。
- 管理员登录,在左侧导航栏选择。
- 在“权限”页面右上角,单击“创建自定义策略”。
- 在“创建自定义策略”页面,参照下表配置相关信息,单击“确定”。
表2 创建自定义策略参数说明 参数
说明
策略名称
自定义策略名称。只能包含大小写字母、中文、数字、空格或特殊字符(-_.,)。
策略配置方式
单击“可视化视图”。
策略内容
为iam子用户配置modelarts服务的api key权限。
- 选择“允许”或“拒绝”。
- “允许”:允许拥有云服务的操作权限。
- “拒绝”:不允许拥有云服务的操作权限。
- 选择云服务,在搜索框输入modelarts,选择“modelarts服务 (modelarts)”。
图5 云服务配置
- 选择操作,在搜索框输入apikey,按需为iam子用户选择api key的操作权限。
- “modelarts:apikey:delete”:选中后,iam子用户可以删除api key。
- “modelarts:apikey:create”:选中后,iam子用户可以创建或编辑api key。
图6 操作配置
策略描述
自定义策略描述。
作用范围
默认为项目级服务。
- 选择“允许”或“拒绝”。
- 为用户组添加自定义策略。
如果您需要新建用户组,请参见创建用户组并授权。
- 管理员登录,在左侧导航栏选择“用户组”。
- 在“用户组”页面,在目标用户组的操作列单击“授权”。
图7 授权用户组
- 在“授权”页面,选中步骤1创建的策略名称,单击“下一步”,按需选择授权范围方案,单击“确定”。
图8 授权页面
- 将iam子用户加入用户组。
如果您需要新建iam子用户,请参见。
删除api key
当api key数量达到上限,或者api key发生泄露、遗忘等情况时,建议您及时删除不再使用的api key。删除后该api key将无法使用且无法找回,请谨慎操作。
- 登录,在顶部导航栏中选择目标区域。
- 在左侧导航栏,选择 。
- 在“api key管理”页面右侧,单击api key右侧的“删除”。
- 在“删除api key”对话框,单击“确定”。
常见问题
- 创建api key后需要等待多久才能生效?
api key在创建后不会立即生效,通常需要等待几分钟才能生效。
- api key是否支持跨区域使用?
api key是区域级别的,不支持跨区域使用。例如,贵阳一区域的api key必须通过贵阳一控制台创建,且仅能在该区域内调用服务。其他区域的api key同理。
相关文档
- 您可以使用已创建的api key,在调用maas部署的模型服务时进行鉴权认证。具体操作,请参见调用已部署的模型服务。
- maas提供了基于maas deepseek api和dify、cherry studio等第三方平台实现ai相关应用的最佳实践,帮助您快速实现ai应用落地。具体操作,请参见使用deepseek api搭建ai应用。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨