面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/get-endpoint-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

获取推理接入点

POST https://ark.cn-beijing.volcengineapi.com/?Action=GetEndpoint&Version=2024-01-01

获取指定推理接入点的详细信息。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

Id string 必选  |  接入点 ID

推理接入点 ID,以 ep- 开头。可通过 ListEndpoints 接口或控制台获取。

响应参数#

BatchOnly boolean  |  批量推理

是否为批量推理接入点。取值为 true 表示接入点仅支持批量推理,false 表示实时推理。

ContentGeneration object  |  生成配置

生图或生视频模型的特化配置,用于设置并发数与每分钟任务数上限。

ConcurrentRequests number  |  并发上限

ContentGeneration.ConcurrentRequests

并发请求数上限。

CreateTaskRpm number  |  建任务 RPM

ContentGeneration.CreateTaskRpm

每分钟创建任务数上限。

CreateTime string  |  创建时间

接入点创建时间,RFC3339 格式。

Description string  |  描述

推理接入点描述,长度不超过 200 字符。

EndpointModelType string  |  模型类型

接入点接入的模型类型。可选值:FoundationModel、CustomModel、ServiceModel。

Id string  |  接入点 ID

推理接入点 ID,以 ep- 开头,作为唯一标识。

ModelReference object  |  模型引用

推理接入点接入的模型引用。二选一返回:基础模型(FoundationModel)或定制模型(CustomModelId)。

CustomModelId string  |  定制模型 ID

ModelReference.CustomModelId

定制模型 ID,以 cm- 开头,接入定制模型时返回。

FoundationModel object  |  基础模型

ModelReference.FoundationModel

基础模型引用,接入基础模型时返回。

ModelVersion string  |  模型版本

ModelReference.FoundationModel.ModelVersion

基础模型版本号。

Name string  |  模型名称

ModelReference.FoundationModel.Name

基础模型名称。

ModelUnitId string  |  模型单元 ID

接入点绑定的模型单元(PTU)ID,以 ptu- 开头。为空表示后付费模式。

Moderation object  |  内容护栏方案

接入点的内容护栏方案。

Strategy string  |  护栏策略

Moderation.Strategy

护栏策略。可选值:Default(系统默认,更低延迟,广泛覆盖内容安全通用需求)、Basic(基础风控,公测中,支持在接口响应中提供命中的风险分类)、Skip(跳过)、Customized(自定义)。

Name string  |  名称

推理接入点名称,创建时由用户指定,长度 1~64 字符。

ProjectName string  |  所属项目

推理接入点所属项目名称。

RateLimit object  |  限流配置

推理接入点限流配置。

Rpm integer  |  RPM 上限

RateLimit.Rpm

每分钟请求数上限(Requests Per Minute)。

Tpm integer  |  TPM 上限

RateLimit.Tpm

每分钟 token 数上限(Tokens Per Minute)。

Ipm integer  |  IPM 上限

RateLimit.Ipm

每分钟生成图片数上限。

RollingId string  |  版本切换 ID

模型版本切换任务 ID,仅当接入点正在切换模型版本时有值。

ScaleTierId string  |  保障包 ID

当接入点关联 TPM 保障包时,返回保障包 ID;否则为空。

Status string  |  状态

推理接入点状态。可选值:Running、Scheduling、Abnormal、Stopped。

StatusReason string  |  状态说明

接入点当前状态的附加说明,如异常原因。正常运行时为空。

SupportRolling boolean  |  支持版本切换

接入点是否支持模型版本切换(滚动升级)。取值为 true 表示支持,false 表示不支持。

SupportScaleTier boolean  |  支持保障包

接入点是否为 TPM 保障包接入点。取值为 true 表示支持,false 表示不支持。

Tags object[]  |  标签

推理接入点绑定的标签列表。

Key string  |  标签键

Tags.Key

标签键,长度 1~64 字符。

Value string  |  标签值

Tags.Value

标签值,长度不超过 256 字符。

UpdateTime string  |  更新时间

接入点更新时间,RFC3339 格式。