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

文档中心

立即注册

导航

GetEndpoint - 获取推理接入点

最近更新时间：2024.11.01 19:44:41首次发布时间：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

返回参数

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

参数	类型	示例值	描述
Endpoint	Object	-	推理接入点

请求示例

POST /?Action=GetEndpoint&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240514T132923Z
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

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240514212927130211155040A854CF",
    "Action": "GetEndpoint",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Endpoint": {
      "Id": "x75xAgf55Q",
      "Name": "ojL2hp2tZ",
      "Description": "uF8CqMQ6BvE",
      "ProjectName": "mk2wZkZ",
      "Tags": [
        {
          "Key": "t",
          "Value": "f"
        }
      ],
      "ModelReference": {
        "CustomModelId": "jv79mE",
        "FoundationModel": {
          "Name": "mcNIw",
          "ModelVersion": "Eac8Hf7"
        }
      },
      "EndpointModelType": "zjd5PJ",
      "ModelUnitId": "qcB",
      "Status": "wEz5",
      "UpdateTime": "s3bP2H0",
      "CreateTime": "SQ36U",
      "RateLimit": {
        "Rpm": 43,
        "Tpm": 275
      },
      "StatusReason": "5vIF"
    }
  }
}

错误码

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