GetApiKey - 获取临时API Key--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

GetApiKey - 获取临时API Key

最近更新时间：2025.01.08 15:29:29首次发布时间：2024.05.15 01:48:34

获取临时API Key，用于在有效期内指定推理接入点、智能体等资源的调用的鉴权

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetApiKey	要执行的操作，取值：GetApiKey。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
DurationSeconds	Integer	是	86400	token有效期单位是s，允许范围0-30d(2592000s)
ResourceType	String	是	endpoint	资源类型，取值范围 endpoint：模型推理接入点 bot：智能体 action：插件
ResourceIds	Array of String	是	["ep-**-", "ep-**-"]	ResourceType字段指定的资源的ID列表

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ExpiredTime	Integer	-	Apikey过期时间，RFC3339格式
ApiKey	String	-	ApiKey

请求示例

POST /?Action=GetApiKey&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250108T072336Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250108/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "DurationSeconds": 86400,
  "ResourceType": "endpoint",
  "ResourceIds": [
    "[\"ep-***\", \"ep-***\"]"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250108152350029189016106C67393",
    "Action": "GetApiKey",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "ExpiredTime": 0,
    "ApiKey": "***-***-***"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.{{Parameter}}	The specified parameter {{Parameter}} is invalid.	请求参数值不合法。请检查参数值的正确性后重试。