You need to enable JavaScript to run this app.
导航
ListEndpoints - 获取推理接入点列表
最近更新时间:2024.05.15 22:58:52首次发布时间:2024.05.15 22:58:52

获取推理接入点列表

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

ListEndpoints

要执行的操作,取值:ListEndpoints。

Version
String

2024-01-01

API的版本,取值:2024-01-01。

PageNumber
Integer

1

分页查询时的起始页码,从 1 开始,默认为 1

PageSize
Integer

10

分页查询时每页显示的记录数,取值:

  • 最小值:1
  • 最大值:100
  • 默认值:10
ProjectName
String

default

项目名称

TagFilters
Array of TagFilter

-

基于绑定的标签的筛选条件

Filter
EndpointFilter

-

待查询接入点的筛选条件

SortBy
String

CreateTime

SortBy

SortOrder
String

Asc

指定排序顺序。 可指定值:

  • Asc: 升序排列
  • Desc:降序排列

返回参数

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

参数
类型
示例值
描述
TotalCount
Integer

100

总接入点数

PageNumber
Integer

1

分页查询时的起始页码,从 1 开始,默认为 1

PageSize
Integer

10

分页查询时每页显示的记录数,取值:

  • 最小值:1
  • 最大值:100
  • 默认值:10
Items
Array of Endpoint

-

接入点信息

请求示例

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

{
  "PageNumber": 1,
  "PageSize": 10,
  "ProjectName": "default",
  "TagFilters": [
    {
      "Key": "SPVdl",
      "Values": [
        "4oQ"
      ]
    }
  ],
  "Filter": {
    "EndpointModelTypes": [
      "rhT"
    ],
    "Statuses": [
      "OM"
    ],
    "ModelVersions": [
      "gQVMJhca1P"
    ],
    "CustomModelIds": [
      "3938w"
    ],
    "FoundationModelName": "vnFbTbR1l",
    "Ids": [
      "592obll5Rho"
    ],
    "Name": "0724147D"
  },
  "SortBy": "4",
  "SortOrder": "lC"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240514213143172211079122D5C1C8",
    "Action": "ListEndpoints",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Items": [
      {
        "Id": "h3w92m",
        "Name": "TT7LbL8V",
        "Description": "eoxAtz8pb01",
        "ProjectName": "lvaqGj",
        "Tags": [
          {
            "Key": "X5b4S2EiYb",
            "Value": "EJUSY0fl"
          }
        ],
        "ModelReference": {
          "CustomModelId": "V0",
          "FoundationModel": {
            "Name": "i",
            "ModelVersion": "6vXDzwOuB7"
          }
        },
        "EndpointModelType": "gIqecA",
        "ModelUnitId": "K",
        "Status": "mekO1h",
        "UpdateTime": "zmUtyY",
        "CreateTime": "oFBriqbTLll",
        "RateLimit": {
          "Rpm": 91,
          "Tpm": 712
        },
        "StatusReason": "fXFny6N"
      }
    ]
  }
}

错误码

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