创建临时应用密钥 - CreateInferTempApiKey
功能介绍
本接口用于在系统中创建一个新的临时API_KEY,适用于需要为用户或应用程序生成临时访问凭证的场景。调用此接口前,确保已具备相应的创建权限,并提供必要的参数,如用户ID或应用程序ID。创建成功后,系统将生成一个唯一的API_KEY,并返回该API_KEY的详细信息,包括临时API_KEY值、创建时间等。如果提供的参数无效,将返回相应的异常信息,提示用户检查输入数据的有效性。
临时API KEY使用方法:
预测接口加上两个header:
X-Api-Key-Type=temp
Authorization=临时API KEY
取值范围:
默认取值:
normal。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts::createTempApikey
Write
-
-
-
-
URI
POST /v2/{project_id}/services/api-keys/temp
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 账号的项目ID。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。获取方法请参见获取IAM用户Token(使用密码)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 否 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| expire_time | 否 | Long | 参数解释: 过期时间。 约束限制: 不能是小数。 取值范围: 最少1小时,最多24小时。 默认取值: 不涉及。 |
| workspace_id | 否 | String | 参数解释:工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| apiKey | String | 参数解释: 临时apikey。 **取值范围:**不涉及。 |
| expireTime | Long | 参数解释: 临时apikey超时时间。 **取值范围:**不涉及。 |
| createTime | Long | 参数解释: 临时apikey创建时间。 **取值范围:**不涉及。 |
请求示例
创建临时应用密钥。
https://{endpoint}/v2/{project_id}/services/api-keys/temp
{
"expire_time" : 2
} 响应示例
状态码:200
应用密钥文件。
{
"api_key" : "eyJkb21haW5faWQiOiIwNGYyNThjODN****example",
"create_time" : 1783044280635,
"expire_time" : 1783051480635
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 应用密钥文件。 |
错误码
请参见错误码。