创建应用密钥 - CreateV2ApiKey
功能介绍
本接口用于在系统中创建一个新的API_KEY，适用于需要为用户或应用程序生成访问凭证的场景。调用此接口前，确保已具备相应的创建权限，并提供必要的参数，如用户ID或应用程序ID。创建成功后，系统将生成一个唯一的API_KEY，并返回该API_KEY的详细信息，包括API_KEY值、创建时间等。如果提供的参数无效或系统中已存在相同的API_KEY，将返回相应的异常信息，提示用户检查输入数据的有效性。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts::createApiKey
Write
-
-
modelarts:apiKey:create
-
URI
POST /v2/{project_id}/services/api-keys
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制： 不涉及。 取值范围： 账号的项目ID。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| Content-Type | 否 | String | 参数解释： 消息体的类型（格式）。 约束限制： 不涉及。 取值范围： 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释： api-key名称，用户在创建API_KEY时自定义。 约束限制： api-key在删除之前名字不能重复。 取值范围： 支持1-64个字符，可以包含字母、汉字、数字、连字符和下划线。 默认取值： 不涉及。 |
| description | 否 | String | 参数解释： api-key描述。 约束限制： 不涉及。 取值范围： 长度不可以超过256，不能包含感叹号，大于号，小于号，等号，与，单引号，双引号。 默认取值： 默认为空。 |
| scope | 是 | String | 参数解释： api-key生效范围。 约束限制： 不涉及。 取值范围： 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | File | 应用密钥文件。 |
请求示例
创建应用密钥。
https://{endpoint}/v2/{project_id}/services/api-keys
{
"name" : "apikey_test",
"scope" : "SERVICE"
} 响应示例
状态码：200
应用密钥文件。
id,api_key,scope,workspace_id,create_time,domain_id,project_id 2c9080f097****example,******,SERVICE,0,2025-05-28T10:04:53.272696578,e57495061d744****example,b33fd65d96474****example
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 应用密钥文件。 |
错误码
请参见错误码。
