# 删除应用密钥 - DeleteInferApiKey #### 功能介绍 本接口用于删除指定的apikey，适用于管理员需要撤销对某个应用程序或用户的访问权限的场景。调用此接口前，确保已获取到需要删除的apikey，并确认apikey未在其他服务中使用。删除成功后，该apikey将无法再用于访问任何相关服务。如果尝试删除不存在或已删除的apikey，将返回相应的异常信息，提示用户检查apikey的有效性。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=DeleteInferApiKey)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:apiKey:delete | Write | apiKey \* | - | - | - | #### URI DELETE /v2/{project_id}/services/api-keys/{key_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制：** 不涉及。 **取值范围：** 账号的项目ID。 **默认取值：** 不涉及。 | | key_id | 是 | String | **参数解释：** apikey_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)获取当前用户拥有的apikey，其中key_id字段即为apikey_id。 **约束限制：** 不涉及。 **取值范围：** apikey_id只能由英文小写字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。获取方法请参见[获取IAM用户Token（使用密码）](https://support.huaweicloud.com/api-modelarts/modelarts_03_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | 表4ServiceIdName | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 服务ID。 **取值范围：** 服务ID。 | | name | String | **参数解释：** 服务名。 **取值范围：** 支持1-128个字符，可以包含字母、汉字、数字、连字符和下划线。 | #### 请求示例 删除应用密钥。 ``` DELETE https://{endpoint}/v2/{project_id}/services/api-keys/{key_id} ``` #### 响应示例 **状态码：200** ``` { "create_time" : 1743494875405, "description" : "test", "domain_id" : "04f258c83e00d5****example", "key_id" : "8a0e847095f063aa0****example", "name" : "api-keys-name-test", "project_id" : "04f258c84780d5****example", "scope" : "SERVICE", "services" : [ ], "workspace_id" : "0" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | apikey信息。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。