CreateEndpoint - 创建推理接入点--火山方舟大模型服务平台-火山引擎

文档中心

导航

CreateEndpoint - 创建推理接入点

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

创建推理接入点

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateEndpoint	要执行的操作，取值：CreateEndpoint。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
Name	String	是	testname	接入点名称
Description	String	否	TestDescription	接入点描述
ModelReference	ModelReference	是	-	接入点接入模型
ModelUnitId	String	否	-	模型单元，为空表示后付费；否则预付费
Tags	Array of Tag	否	-	接入点绑定的标签
ProjectName	String	否	default	项目名称
DryRun	Boolean	否	true	是否仅对此请求进行预检。取值： true：发送检查请求。 false(默认)：发送正常请求
RateLimit	EndpointRateLimitParam	否	-	接入点限流

返回参数

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

参数	类型	示例值	描述
Id	String	ep-test-id	接入点的ID

请求示例

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

{
  "Name": "testname",
  "Description": "TestDescription",
  "ModelReference": {
    "CustomModelId": "SxU71Q1t",
    "FoundationModel": {
      "Name": "yzcHNZMJ736",
      "ModelVersion": "4Rh90omlqN"
    }
  },
  "ModelUnitId": "\\-",
  "Tags": [
    {
      "Key": "B",
      "Value": "3ScqC"
    }
  ],
  "ProjectName": "default",
  "DryRun": true,
  "RateLimit": {
    "Rpm": 651,
    "Tpm": 798
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240514212750152186163065FE5A2A",
    "Action": "CreateEndpoint",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": "ep-test-id"
  }
}

错误码

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