# 批量解绑应用密钥 - BatchUnbindInferApiKeys #### 功能介绍 本接口用于将已绑定的apikey从指定服务中批量解绑，适用于需要撤销多个apikey对特定服务的访问权限的场景。调用此接口前，确保已获取到需要解绑的多个apikey，并确认这些apikey当前绑定在指定服务上。解绑成功后，这些apikey将不再对指定服务生效，但仍可继续用于其他服务。如果尝试解绑不存在或未绑定到指定服务的apikey，将返回相应的异常信息，提示用户检查apikey的有效性和绑定状态。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=BatchUnbindInferApiKeys)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:apiKey:unbind | Write | apiKey \* | - | - | - | | modelarts:apiKey:unbind | Write | service \* | - | - | - | #### URI POST /v2/{project_id}/services/{service_id}/api-keys/batch-unbind 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制：** 不涉及。 **取值范围：** 账号的项目ID。 **默认取值：** 不涉及。 | | service_id | 是 | String | **参数解释：** 服务ID，在[创建服务](https://support.huaweicloud.com/api-modelarts/CreateInferService.html#ZH-CN_TOPIC_0000002723741846)时即可在返回体中获取，也可通过[查询服务列表](https://support.huaweicloud.com/api-modelarts/ListInferServices.html#ZH-CN_TOPIC_0000002723741848)获取当前用户拥有的服务，其中service_id字段即为服务ID。 **约束限制：** 不涉及。 **取值范围：** 服务ID。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。获取方法请参见[获取IAM用户Token（使用密码）](https://support.huaweicloud.com/api-modelarts/modelarts_03_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | 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个。 | 表4key_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列表。 | 表6ApiKeyResponseV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_id | String | **参数解释：** api-key的ID，在[创建API_KEY](https://support.huaweicloud.com/api-modelarts/CreateInferApiKey.html#ZH-CN_TOPIC_0000002753501519)时即可在返回体中获取，也可通过[查询api-keys列表](https://support.huaweicloud.com/api-modelarts/ListInferApiKeys.html#ZH-CN_TOPIC_0000002723901774)获取当前用户拥有的api-key，其中id字段即为api-key的ID。 **取值范围：** UUID格式。 | | name | String | **参数解释：** api-key的名称，在[创建API_KEY](https://support.huaweicloud.com/api-modelarts/CreateInferApiKey.html#ZH-CN_TOPIC_0000002753501519)时自定义。 **取值范围：** 支持1-64个字符，可以包含字母、汉字、数字、连字符和下划线。 | | description | String | **参数解释：** api-key的描述，在[创建API_KEY](https://support.huaweicloud.com/api-modelarts/CreateInferApiKey.html#ZH-CN_TOPIC_0000002753501519)时自定义。 **取值范围：** 支持1-256个字符，可以包含字母、汉字、数字、连字符和下划线。 | | create_time | String | **参数解释：** api-key的创建时间，根据创建时的当前时间自动生成。 **取值范围：** 毫秒级时间戳，13位数字，如1609459200000。 | | scope | String | **参数解释：** api-key生效范围。 **取值范围：** - USER：表示生效范围为用户级别，可以访问该用户创建的所有在线服务。 - SERVICE：表示生效范围为单个服务，可以访问绑定该api-key的在线服务。 | | domain_id | String | **参数解释：** 用户domain ID。获取方法请参见[获取账号名和账号ID](https://support.huaweicloud.com/api-modelarts/modelarts_03_0148.html)。 **取值范围：** 账号ID。 | | project_id | String | **参数解释：** 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **取值范围：** 账号的项目ID。 | | services | Array of [ServiceIdName] objects | **参数解释：** 绑定此api-key的在线服务列表。 | | workspace_id | String | **参数解释：** 工作空间ID。 **取值范围：** 工作空间ID。 | 表7ServiceIdName | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 服务ID。 **取值范围：** 服务ID。 | | name | String | **参数解释：** 服务名。 **取值范围：** 支持1-128个字符，可以包含字母、汉字、数字、连字符和下划线。 | 表8ApiKeyFailureResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_id | String | **参数解释：** api-key的ID，在[创建API_KEY](https://support.huaweicloud.com/api-modelarts/CreateInferApiKey.html#ZH-CN_TOPIC_0000002753501519)时即可在返回体中获取，也可通过[查询api-keys列表](https://support.huaweicloud.com/api-modelarts/ListInferApiKeys.html#ZH-CN_TOPIC_0000002723901774)获取当前用户拥有的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-unbind { "key_ids" : [ "key-id-1", "key-id-2", "key-id-3" ] } ``` #### 响应示例 **状态码：200** ``` { "total" : 2, "success_count" : 1, "success_items" : [ { "create_time" : 1743228962325, "description" : "test", "domain_id" : "04f258c83e00d****example", "key_id" : "8a0e4a2d95e088ea****example", "name" : "testttt", "project_id" : "04f258c84780d5a****example", "scope" : "SERVICE", "services" : [ { "id" : "bd689f90-bbf5-4638-a96b-f3****example", "name" : "service_name***example" } ], "workspace_id" : "eab57afd5e8a4fc9a6****example" } ], "failure_count" : 1, "failure_items" : [ { "key_id" : "8a0e4a2d95e088ea01****example", "error_code" : "ModelArts.8024", "error_msg" : "bd689f90-bbf5-4638-a96b-f****example service not found" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功给服务解绑多个apikey。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。