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

获取推理接入点列表

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

分页查询推理接入点列表,支持按项目、标签、模型、状态等多维度筛选。

鉴权#

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

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

请求参数#

Body 参数#

Filter object  |  接入点筛选条件

接入点筛选条件,各子字段之间为「与」关系。格式如下:{ "Statuses": ["Running"], "FoundationModelName": "doubao-seed-2-1-pro-260628" }。

CustomModelIds string[]  |  定制模型 ID 筛选

Filter.CustomModelIds

按定制模型 ID 列表精确筛选。

Domain string  |  接入点类型筛选

Filter.Domain

按接入点类型筛选。可选值:

  • Ark
  • Mlp
EndpointModelTypes string[]  |  模型类型筛选

Filter.EndpointModelTypes

按接入模型类型筛选。可选值:

  • FoundationModel
  • CustomModel
  • ServiceModel
FoundationModelName string  |  基础模型名称筛选

Filter.FoundationModelName

按基础模型名称模糊匹配。

Ids string[]  |  接入点 ID 筛选

Filter.Ids

按接入点 ID 列表精确筛选。

ModelOrServiceName string  |  模型/服务名称筛选

Filter.ModelOrServiceName

按模型名称或 MLP 服务名称模糊匹配。

ModelVersions string[]  |  模型版本筛选

Filter.ModelVersions

按基础模型版本列表精确筛选。

Name string  |  接入点名称筛选

Filter.Name

按接入点名称模糊匹配。

PaymentType string  |  付费方式筛选

Filter.PaymentType

按付费方式筛选。可选值:

  • ModelUnit:模型单元。
  • ScaleTier:TPM 保障包。
  • 不传或为空:不区分付费方式
ServiceInfoIds string[]  |  MLP 服务 ID 筛选

Filter.ServiceInfoIds

按 MLP 推理服务 ID 列表筛选,仅 Domain 为 Mlp 时有效。

Statuses string[]  |  状态筛选

Filter.Statuses

按接入点状态筛选。可选值:

  • Running
  • Scheduling
  • Abnormal
  • Stopped
PageNumber integer 默认值 1  |  起始页码

分页查询时的页码,从 1 开始。

PageSize integer 默认值 10  |  每页记录数

分页查询时每页显示的记录数,取值范围 1~100。

ProjectName string 默认值 default  |  项目名称

按项目名称过滤接入点,精确匹配。

SortBy string 默认值 CreateTime  |  排序字段

排序字段。可选值:

  • CreateTime(默认):创建时间。
  • UpdateTime:更新时间。
SortOrder string 默认值 Desc  |  排序顺序

排序顺序。可选值:

  • Asc:升序。
  • Desc(默认):降序。
TagFilters object[]  |  标签筛选条件

按标签筛选接入点,多条之间为「与」关系,同一 Key 的多个 Values 之间为「或」关系。格式如下:[ { "Key": "env", "Values": ["stg", "boe"] } ]。

Key string 必选  |  标签键

TagFilters.Key

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

Values string[]  |  标签值列表

TagFilters.Values

标签值列表;为空时表示该 Key 下所有标签值均匹配。

响应参数#

Items object[]  |  接入点列表

接入点列表,数组每个元素为一个接入点的精简信息。格式如下:[ { "Id": "ep-20260507230659-skvgn", "Name": "curl_bot_test", "Status": "Running" } ]。

CreateTime string  |  创建时间

Items.CreateTime

创建时间,RFC3339 格式。

EndpointModelType string  |  模型类型

Items.EndpointModelType

接入模型类型。可选值:

  • FoundationModel
  • CustomModel
  • ServiceModel
Id string  |  接入点 ID

Items.Id

推理接入点 ID。

ModelReference object  |  模型引用

Items.ModelReference

接入模型引用。格式如下:{ "FoundationModel": { "Name": "doubao-seed-2-1-pro-260628", "ModelVersion": "250615" } }。

CustomModelId string  |  定制模型 ID

Items.ModelReference.CustomModelId

定制模型 ID,以 cm- 开头。

FoundationModel object  |  基础模型引用

Items.ModelReference.FoundationModel

ModelVersion string  |  模型版本

Items.ModelReference.FoundationModel.ModelVersion

基础模型版本号。

Name string  |  基础模型名称

Items.ModelReference.FoundationModel.Name

Name string  |  接入点名称

Items.Name

ProjectName string  |  项目名称

Items.ProjectName

RateLimit object  |  限流配置

Items.RateLimit

限流配置。格式如下:{ "Rpm": 600, "Tpm": 100000 }。

Rpm integer  |  每分钟请求数

Items.RateLimit.Rpm

每分钟请求数上限。

Tpm integer  |  每分钟 Token 数

Items.RateLimit.Tpm

每分钟 token 数上限。

Ipm integer  |  每分钟图片数

Items.RateLimit.Ipm

每分钟生成图片数上限。

Status string  |  接入点状态

Items.Status

接入点状态。可选值:

  • Running
  • Scheduling
  • Abnormal
  • Stopped
Tags object[]  |  标签列表

Items.Tags

接入点绑定的标签列表。

Key string  |  标签键

Items.Tags.Key

Value string  |  标签值

Items.Tags.Value

UpdateTime string  |  更新时间

Items.UpdateTime

更新时间,RFC3339 格式。

ContentGeneration object  |  生图/生视频配置

Items.ContentGeneration

生图 / 生视频模型的特化配置。格式如下:{ "ConcurrentRequests": 10, "CreateTaskRpm": 60 }。

ConcurrentRequests number  |  并发请求数

Items.ContentGeneration.ConcurrentRequests

并发请求数上限。

CreateTaskRpm number  |  每分钟创建任务数

Items.ContentGeneration.CreateTaskRpm

每分钟创建任务数上限。

Description string  |  接入点描述

Items.Description

ModelUnitId string  |  模型单元 ID

Items.ModelUnitId

模型单元(PTU)ID,以 ptu- 开头。

PaymentType string  |  付费方式

Items.PaymentType

付费方式。可选值:

  • ModelUnit:模型单元。
  • ScaleTier:TPM 保障包。
  • 不传或为空:按 Token 付费
StatusReason string  |  状态说明

Items.StatusReason

状态附加说明。

PageNumber integer  |  当前页码

当前返回的页码,与请求参数 PageNumber 一致。

PageSize integer  |  每页记录数

当前返回的每页记录数,与请求参数 PageSize 一致。

TotalCount integer  |  接入点总数

满足筛选条件的接入点总数。