签名鉴权方式

火山方舟API分为模型调用的API，以及其他管理推理接入点等管控面相关的其他API。他们支持的鉴权方式有所不同，下面介绍方舟相关的API鉴权方式。

模型/应用调用API鉴权

API Key 签名鉴权

前提条件

您已获取到API Key。如需创建/查看API Key，请参见1.获取并配置 API Key 。

获取 Model ID 作为推理接入点用于模型调用，请参考获取 Model ID。（此方式目前仅支持 API Key 鉴权）

说明

如果您想更灵活的配置使用的大模型及其版本、限流、计费类型（前付费/后付费）、运行状态、调用监控等，推荐您使用 Endpoint ID 作为推理接入点，可以参考获取 Endpoint ID。

签名构造

API Key 签名鉴权方式要求在 HTTP 请求 header 中按如下方式添加 Authorization header:

API 调用示例

Access Key 签名鉴权

前提条件

您已获取到Access Key。如需创建/查看Access Key，请参见API访问密钥管理。

由于主账号的Access Key拥有较大权限，建议您创建IAM用户并授予方舟等权限，然后使用IAM用户的Access Key来进行操作，具体请参见使用IAM进行访问控制教程。

调用模型/调用应用

您可以使用下面方式来间接完成 Access Key 签名鉴权。

获取临时 API Key：使用 Access Key 调用 GetApiKey - 获取临时API Key 接口，获取指定资源（推理接入点/应用）的临时 API Key。

使用临时 API Key，来鉴权模型/应用调用，方式同上，见API Key 签名鉴权。

说明

方舟已经提供了SDK，可以直接使用 Access Key 完成接口的鉴权，无需自行实现签名。

Python SDK：使用Access Key鉴权。

Go SDK：使用Access Key鉴权。

Java SDK：使用Access Key鉴权。

通过Access Key 鉴权，只支持通过Endpoint ID调用，不支持通过Model ID 调用，即请求体中model字段需要配置为Endpoint ID。

其他API鉴权

管控面的API，如管理API Key、管理推理接入点等接口。

Access Key 签名鉴权

前提条件

您已获取到Access Key。如需创建/查看Access Key，请参见API访问密钥管理。

由于主账号的Access Key拥有较大权限，建议您创建IAM用户并授予方舟等权限，然后使用IAM用户的Access Key来进行操作，具体请参见使用IAM进行访问控制教程。

使用步骤

使用 Access Key 构造签名。具体方法请参见签名方法。

签名用到的方舟相关字段信息：

Service：ark
Region：cn-beijing

使用cURL发起请求，请求示例如下：

API Key 签名鉴权#

前提条件#

签名构造#

API 调用示例#

Access Key 签名鉴权#

前提条件#

调用模型/调用应用#

Access Key 签名鉴权#

前提条件#

使用步骤#

API Key 签名鉴权

前提条件

签名构造

API 调用示例

Access Key 签名鉴权

前提条件

调用模型/调用应用

Access Key 签名鉴权

前提条件

使用步骤