GetEndpoint - 获取推理接入点--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

GetEndpoint - 获取推理接入点

最近更新时间：2025.01.08 22:29:03首次发布时间：2024.05.15 22:58:52

获取推理接入点

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetEndpoint	要执行的操作，取值：GetEndpoint。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
Id	String	是	test-ep-id	模型接入的ID

返回参数

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

参数	类型	示例值	描述
Moderation	Object	-	内容护栏方案
CreateTime	String	-	接入点创建时间，RFC3339格式
Description	String	-	接入点描述
EndpointModelType	String	FoundationModel	接入点模型类型。取值: FoundationModel：基础模型 CustomModel：定制模型
Id	String	ep--	推理接入点的ID
ModelReference	Object	-	接入点接入模型
ModelUnitId	String	-	模型单元
Name	String	-	接入点名称
ProjectName	String	-	项目名称
RateLimit	Object	-	接入点限流
Status	String	-	接入点状态
StatusReason	String	-	状态附加说明信息
SupportScaleTier	Boolean	false	是否支持TPM保障包
Tags	Array of Object	-	接入点绑定的标签
UpdateTime	String	-	接入点更新时间，RFC3339格式
RollingId	String	-	接入点切换的Id
ScaleTierId	String	-	如果存在 TPM 保障包，则为 TPM 保障包 ID
BatchOnly	Boolean	true	是否只支持 BatchChat。如果为true，只能访问 Batch 推理接口，否则只能访问在线推理接口。
SupportRolling	Boolean	false	是否支持接入点切换模型版本

请求示例

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

{
  "Id": "test-ep-id"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241231191522021037040243127434",
    "Action": "GetEndpoint",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "SupportRolling": false,
    "CreateTime": "ZFC",
    "Description": "4i2e8gPBufo",
    "EndpointModelType": "R3",
    "Id": "n9It",
    "ModelReference": {
      "CustomModelId": "ok",
      "FoundationModel": {
        "Name": "JarKT21",
        "ModelVersion": "EQS"
      }
    },
    "ModelUnitId": "E",
    "Name": "AGEWR",
    "ProjectName": "b0",
    "RateLimit": {
      "Rpm": 118,
      "Tpm": 251
    },
    "Status": "b22",
    "StatusReason": "IQ",
    "SupportScaleTier": false,
    "Tags": [
      {
        "Key": "oT0JUKb9G",
        "Value": "m9PYoDk7"
      }
    ],
    "UpdateTime": "FPPT",
    "RollingId": "gKU9eyRE",
    "ScaleTierId": "kJQWZk2DqL"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。