更新时间:2026-11-13 GMT+08:00
分享

通过API KEY认证访问在线服务

如果在线服务的状态处于“运行中”,则表示在线服务已部署成功。部署成功的在线服务,将为用户提供一个可调用的API,此API为标准Websocket API。在使用CloudRobo提供的在线服务时,用户需要通过API调用进行模型预测,需进行身份认证以确保安全。然而,传统的认证方式可能需要复杂的配置和管理,增加了开发和维护的难度。如何在保证安全的前提下,简化API调用的认证流程?CloudRobo支持使用API KEY认证方式访问在线服务。

在向在线服务发起预测请求时,需要提前获取API KEY,在请求头中添加认证信息。API KEY是通过API密钥进行API调用时的认证。API KEY是每个用户单独的身份认证,是个人调用应用接口的依据,必须妥善保管。API KEY认证适用于需要简单认证的场景,只要有用API KEY凭据的用户都可以访问在线服务。

约束与限制

  • 外网访问开关仅在已部署模型服务处于“停止”状态时可修改,运行中不支持修改。
  • 请妥善保管API KEY,避免泄露。API KEY是调用在线服务的身份凭据,任何持有API KEY的用户均可访问对应的在线服务。

前提条件

  • 创建部署模型服务时认证方式选择“API KEY认证”。
    图1 在线服务部署API KEY认证方式配置示例
  • 调用API时请求并发量、请求体大小以及请求超时时间需小于等于部署时的设定值,否则会导致请求失败。

创建模型部署服务时开启外网访问

  1. 登录CloudRobo控制台。
  2. 在左侧导航栏中选择“运行管理 > 模型部署”,进入模型部署页面。
  3. 单击右上角“部署模型服务”,进入创建页面。
  4. 在创建页面配置相关参数时,开启“外网访问”开关,如下图所示。

    图2 开启外网访问

  5. 单击“立即部署”,完成模型部署服务创建。

修改已部署模型服务的外网访问开关

仅当已部署模型服务处于“停止”状态时,可修改外网访问开关。“运行中”的服务不支持直接修改。

  1. 在已部署模型服务列表中,单击目标服务“操作”列的“停止”,将服务停止。
  2. 单击已部署模型服务名称,进入部署详情页,在“概览”页签中,修改“部署管理配置” 下的“外网访问”开关状态。
  3. 重新启动服务后,按新配置生效。

获取在线服务的调用地址和API KEY

在调用服务前,需要获取在线服务的调用地址和API KEY。

服务处于“运行中”状态且已开启外网访问时,用户获取API KEY文件,用于外网调用服务时的身份认证。

  • 部署模型服务在公共资源池且服务处于“运行中”状态时,开启外网访问后,系统将自动创建API KEY,关闭外网访问时系统自动删除已有API KEY。
  • 部署模型服务在专属资源池且服务处于“运行中”状态时,开启外网访问后,获取API KEY请参考更新API Key。
  1. 在模型部署服务列表中,单击目标推理服务名称,进入部署详情页。
  2. 在“概览”页签的“部署管理配置”区域,获取在线服务的调用地址(外网调用URL)和API KEY(网络认证)。

    图3 获取外网调用URL和API KEY(公共资源池场景)
    图4 获取外网调用URL和API KEY(专属资源池场景)

    API KEY文件内容示例如下:

    # service_id: {service_id}
    # api_key_id: ak-xxxxxxxx
    sk-xxxxxxxxxxxxxxxxxxxx

通过外网调用URL调用在线服务

获取在线服务的调用地址和API KEY后,用户可通过OpenAI兼容协议从外网调用在线服务,将在线服务集成到外部应用系统中。

相关文档