POST https://ark.cn-beijing.volcengineapi.com/?Action=UpdateEndpoint&Version=2024-01-01
更新一个已创建的推理接入点(Endpoint)的可变配置,包括名称、描述、限流配置、标签、模型推理默认参数、水印与内容安全护栏等。仅传入需要变更的字段,未传字段保持原值。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
Id string 必选 | 接入点 ID
待更新的推理接入点 ID,以 ep- 开头。可通过 ListEndpoints 接口获取。
AgenticStrategy object | Agent 策略
Agent 策略配置,包含 Skill 与上下文压缩等子项
AgenticSkill object 必选 | AgenticSkill
AgenticStrategy.AgenticSkill
字段
AgenticSkillInfos object[] 必选 | AgenticSkill
AgenticStrategy.AgenticSkill.AgenticSkillInfos
字段
ID string 必选 | ID
AgenticStrategy.AgenticSkill.AgenticSkillInfos.ID
标识
Type string 必选 | 类型
AgenticStrategy.AgenticSkill.AgenticSkillInfos.Type
类型。可选值:Custom、Sharing。
Version string 必选 | 版本
AgenticStrategy.AgenticSkill.AgenticSkillInfos.Version
VersionID string | VersionID
AgenticStrategy.AgenticSkill.AgenticSkillInfos.VersionID
Version 标识
Enabled number 必选 | 启用 Agent 技能
AgenticStrategy.AgenticSkill.Enabled
是否启用 Agent 技能
Mode string 必选 | 技能模式
AgenticStrategy.AgenticSkill.Mode
Agent 技能模式。取值 Auto(自动)、Custom(自定义)
AgenticContext object | AgenticConte
AgenticStrategy.AgenticContext
字段
AgenticContextTosLocation object 必选 | AgenticConte
AgenticStrategy.AgenticContext.AgenticContextTosLocation
字段
BucketName string 必选 | TOS 桶名称
AgenticStrategy.AgenticContext.AgenticContextTosLocation.BucketName
TOS 桶名称 在创建和选择 TOS 桶时请注意,当前火山方舟只支持 华北 2-北京 地域(region: cn-beijing)的存储桶
ObjectKey string 必选 | TOS 对象路径
AgenticStrategy.AgenticContext.AgenticContextTosLocation.ObjectKey
CompressionEnabled number 必选 | CompressionE
AgenticStrategy.AgenticContext.CompressionEnabled
字段
AllowDataCollected boolean | 允许数据采集
是否允许采集调用数据用于模型训练或数据回流
ContentGeneration object | 生图/生视频配置
生图 / 生视频模型的特化配置。不传表示不修改。
ConcurrentRequests number | 并发请求数
ContentGeneration.ConcurrentRequests
并发请求数上限。
CreateTaskRpm number | 每分钟任务数
ContentGeneration.CreateTaskRpm
每分钟创建任务数上限。
DataDelivery boolean | 数据回流
是否开启数据回流
Description string | 接入点描述
接入点新描述,长度不超过 200 字符。不传表示不修改描述。
DryRun boolean 默认值 false | 预检模式
是否仅进行预检。取值 true 表示仅校验请求合法性,不实际更新接入点;false 表示正式执行更新。
Fallback object | 降级配置
降级配置。主模型不可用时按候选模型顺序回退
NeedFallback number 必选 | NeedFallback
Fallback.NeedFallback
是否需要 Fallback
CandidateModels object[] | CandidateMod
Fallback.CandidateModels
字段
ModelVersion string 必选 | 基础模型版本
Fallback.CandidateModels.ModelVersion
Name string 必选 | 基础模型名
Fallback.CandidateModels.Name
ConfigurationId string | 基础模型配置 ID
Fallback.CandidateModels.ConfigurationId
InferenceDefaultParam object | 推理默认参数
推理默认参数配置,调用接入点时未显式指定的参数将使用此处的默认值
ThinkingConfig object | ThinkingConf
InferenceDefaultParam.ThinkingConfig
Thinking 配置
Value string 必选 | 值
InferenceDefaultParam.ThinkingConfig.Value
IsSupported number | IsSupported
InferenceDefaultParam.ThinkingConfig.IsSupported
是否 Supported
InferenceFoundry object | 推理工厂配置
推理工厂(Inference Foundry)配置,用于自定义推理性能档位
InferenceFoundryPerformance object | InferenceFou
InferenceFoundry.InferenceFoundryPerformance
字段
Tier integer | Tier
InferenceFoundry.InferenceFoundryPerformance.Tier
字段
Tpm integer | Tpm
InferenceFoundry.InferenceFoundryPerformance.Tpm
字段
LimitCoefficient object | 限流系数
限流系数配置,用于调整接入点限流策略
NeedLimitCoefficient number 必选 | NeedLimitCoe
LimitCoefficient.NeedLimitCoefficient
是否需要 LimitCoefficient
Moderation object | 内容安全护栏
内容护栏方案。不传表示不修改。Strategy 必填;仅当 Strategy 为 Customized 时填写 CustomizedModerationInfos。
Strategy string 必选 | 内容安全护栏方案
Moderation.Strategy
内容安全护栏方案。取值:
Default(默认): 更低延迟,广泛覆盖内容安全通用需求Basic:基本方案(公测中)。支持在接口响应中提供命中的风险分类,暂时只包含严重违规和激进行为两类风险。Skip:跳过内容审核。Customized:自定义内容审核。
Name string | 接入点名称
接入点新名称,长度 1~64 字符。不传表示不修改名称。
NeedWatermark boolean | 启用水印
生成内容是否需要添加水印。启用后需同时填写 WatermarkInfo
RateLimit object | 限流配置
接入点限流配置。不传表示不修改。其中 Rpm 与 Tpm 必填,Ipm 与 FastTpm 按需填写。
Rpm integer 必选 | 每分钟请求数
RateLimit.Rpm
每分钟请求数上限(Requests Per Minute)。
Tpm integer 必选 | 每分钟请求 token 数
RateLimit.Tpm
每分钟 token 数上限(Tokens Per Minute)。
Ipm integer | 每分钟生成图片数
RateLimit.Ipm
每分钟生成图片数上限。仅生图模型有效。
ServiceInfo object | MLP 服务信息
MLP 推理服务信息。仅当接入点 Domain 为 Mlp 时可更新,可更新 ModelName 与 ServiceName。
Id string | MLP 服务 ID
ServiceInfo.Id
MLP 推理服务 ID,以 msrv- 开头。
ModelName string | MLP 模型名称
ServiceInfo.ModelName
MLP 服务对应的模型名称。
Region string | MLP 服务地域
ServiceInfo.Region
MLP 推理服务所在区域,如 cn-beijing、ap-southeast-1。
ServiceName string | MLP 服务名称
ServiceInfo.ServiceName
Tags object[] | 标签列表
接入点绑定的标签列表。更新时整体替换原有标签。
Key string 必选 | 标签键
Tags.Key
标签键,长度 1~64 字符。
Value string 必选 | 标签值
Tags.Value
标签值,长度不超过 256 字符。
WatermarkInfo object | 水印主体信息
水印主体信息。当 NeedWatermark 为 true 时填写
SocialUnifiedCreditCode string 必选 | 统一社会信用代码
WatermarkInfo.SocialUnifiedCreditCode
SubjectName string 必选 | 水印主体名称
WatermarkInfo.SubjectName
IsContentDissemination number | 是否允许内容传播
WatermarkInfo.IsContentDissemination
响应参数#
本接口无特有的返回参数,成功时 HTTP 状态码为 200,返回结构中 Result 为空对象 {}。