文档首页/ 魔坊（ModelArts）模型训推平台/ API参考/ 模型推理（新版）/ 应用密钥管理/ 批量绑定应用密钥 - BatchBindV2ApiKeys
更新时间：2026-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量绑定应用密钥 - BatchBindV2ApiKeys

功能介绍

本接口用于将生成的多个apikey与指定服务进行批量绑定，用于访问特定服务。调用此接口前，确保已成功创建服务实例，并获取到有效的apikey。绑定成功后，apikey将作为服务调用时的身份验证凭证，确保仅授权用户能够访问该服务。如果尝试绑定已失效或已绑定当前服务的apikey将返回相应的异常信息，提示用户检查apikey的有效性和绑定状态。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts:apiKey:bind

    Write

    apiKey *

    -

    -

    -

    service *

    -

URI

POST /v2/{project_id}/services/{service_id}/api-keys/batch-bind

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及。

取值范围：

账号的项目ID。

默认取值：

不涉及。

service_id

是

String

参数解释：

服务ID，在创建服务时即可在返回体中获取，也可通过查询服务列表获取当前用户拥有的服务，其中service_id字段即为服务ID。

约束限制：

不涉及

取值范围：

服务ID

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及。

取值范围：

  • application/json。

  • application/json;charset=utf-8。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

key_ids

是

Array of key_ids objects

参数解释：

请求批量绑定的api-key的id数组。

约束限制：

请求批量绑定api-key的id个数不超过10个。
表4 key_ids

参数

是否必选

参数类型

描述

key_id

是

String

参数解释：

apikey_id，在创建API_KEY时即可在返回体中获取，也可通过查询api-keys列表获取当前用户拥有的apikey，其中key_id字段即为apikey_id。

约束限制：

不涉及

取值范围：

apikey_id只能由英文小写字母、数字组成，且长度为32个字符。

默认取值：

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

请求绑定apikey总个数。

取值范围：

不涉及。

success_count

Integer

参数解释：

绑定apikey成功个数。

取值范围：

不涉及。

success_items

Array of ApiKeyResponseV2 objects

参数解释：

绑定成功的apikey列表。

failure_count

Integer

参数解释：

绑定apikey失败个数。

取值范围：

不涉及。

failure_items

Array of ApiKeyFailureResponse objects

参数解释：

绑定失败的apikey列表。
表6 ApiKeyResponseV2

参数

参数类型

描述

key_id

String

参数解释：

api-key的ID，在创建API_KEY时即可在返回体中获取，也可通过查询api-keys列表获取当前用户拥有的api-key，其中id字段即为api-key的ID。

取值范围：

UUID格式。

name

String

参数解释：

api-key的名称，在创建API_KEY时自定义。

取值范围：

支持1-64个字符，可以包含字母、汉字、数字、连字符和下划线。

description

String

参数解释：

api-key的描述，在创建API_KEY时自定义。

取值范围：

支持1-256个字符，可以包含字母、汉字、数字、连字符和下划线。

create_time

String

参数解释：

api-key的创建时间，根据创建时的当前时间自动生成。

取值范围：

毫秒级时间戳，13位数字，如1609459200000。

scope

String

参数解释：

api-key生效范围。

取值范围：

  • USER：表示生效范围为用户级别，可以访问该用户创建的所有在线服务。

  • SERVICE：表示生效范围为单个服务，可以访问绑定该api-key的在线服务。

domain_id

String

参数解释：

用户domain ID。获取方法请参见获取账号名和账号ID。

取值范围：

账号ID。

project_id

String

参数解释：

用户项目ID。获取方法请参见](modelarts_03_0147.xml)。

取值范围：

账号的项目ID。

services

Array of ServiceIdName objects

参数解释：

绑定此api-key的在线服务列表。

workspace_id

String

参数解释：

工作空间ID。

取值范围：

工作空间ID。
表7 ServiceIdName

参数

参数类型

描述

id

String

参数解释：

服务ID。

取值范围：

服务ID。

name

String

参数解释：

服务名。

取值范围：

支持1-128个字符，可以包含字母、汉字、数字、连字符和下划线。
表8 ApiKeyFailureResponse

参数

参数类型

描述

key_id

String

参数解释：

api-key的ID，在创建API_KEY时即可在返回体中获取，也可通过查询api-keys列表获取当前用户拥有的api-key，其中id字段即为api-key的ID。

取值范围：

UUID格式。

error_code

String

参数解释：

ModelArts错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

具体错误信息。

取值范围：

不涉及。

请求示例

给服务批量绑定多个apikey。

POST /v2/{project_id}/services/{service_id}/api-keys/batch-bind

响应示例

状态码：200

成功给服务绑定apikey。

{
  "total" : 2,
  "success_count" : 1,
  "success_items" : [ {
    "create_time" : 1743228962325,
    "description" : "test",
    "domain_id" : "04f258c83e00d5a50f3****example",
    "key_id" : "8a0e4a2d95e088ea0195e0****example",
    "name" : "test66",
    "project_id" : "04f258c84780d5a52f3bc****example",
    "scope" : "SERVICE",
    "services" : [ {
      "id" : "bd689f90-bbf5-4638-a96b-f3a****example",
      "name" : "test-infer-raw1234567"
    } ],
    "workspace_id" : "eab57afd5e8a4fc9a66d68****example"
  } ],
  "failure_count" : 1,
  "failure_items" : [ {
    "key_id" : "8a0e4a2d95e088ea0****example",
    "error_code" : "ModelArts.8024",
    "error_msg" : "bd689f90-bbf5-4638-a96b-f3a****example service not found"
  } ]
}

状态码

状态码

描述

200

成功给服务绑定apikey。

错误码

请参见错误码。

父主题： 应用密钥管理