获取推理接入点列表 ## 调试 [去调试](https://api.volcengine.com/api-explorer/?action=ListEndpoints&groupName=%E7%AE%A1%E7%90%86%E6%8E%A8%E7%90%86%E6%8E%A5%E5%85%A5%E7%82%B9%EF%BC%88Endpoint%EF%BC%89&serviceCode=ark&version=2024-01-01) ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **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` * 资源所属的项目名称，默认值为default。 * 若资源不在默认项目中，需填写正确的项目名称，获取项目名称，请查看[文档](https://docs.volcengine.com/docs/82379/1359411?lang=zh#.5aaC5L2V6I635Y-W6aG555uu5ZCN56ew77yIcHJvamVjdC1uYW1l77yJ77yf)。 **TagFilters** object[] `可选` `示例值：\-` 基于绑定的标签的筛选条件 **Key** string 必选标签键 **Values** string[] `可选` 标签值 **Filter** object `可选` `示例值：\-` 待查询接入点的筛选条件 **EndpointModelTypes** string[] `可选` 接入模型类型，模型广场上的基础模型或模型仓库中的定制模型 **Statuses** string[] `可选` 接入点状态 **ModelVersions** string[] `可选` 模型版本 **CustomModelIds** string[] `可选` 定制模型的ID **FoundationModelName** string `可选` 基础模型名称，模糊查询 **Ids** string[] `可选` 接入点的ID **Name** string `可选` 接入点名称，模糊查询 **ServiceInfoIds** string[] `可选` mlp服务Id列表 **ModelOrServiceName** string `可选` 方舟模型名称或mlp服务名称 **PaymentType** string `可选` Endpoint的付费方式。取值： * ModelUnit：模型单元 * ScaleTier：TPM保障包 * nil：不区分任何付费方式 **Domain** string `可选` `示例值：Ark` 接入点的类型。取值： * Ark:方舟接入点 * Mlp: mlp接入点。 * 为空默认表示查询所有类型的接入点 **SortBy** string `可选` `示例值：CreateTime` 指定排序指标。可指定值: * CreateTime：创建时间 * UpdateTime：更新时间 **SortOrder** string `可选` `示例值：Asc` 指定排序顺序。可指定值: * Asc：升序排列 * Desc：降序排列 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **TotalCount** integer `示例值：100` 总接入点数 **PageNumber** integer `示例值：1` 分页查询时的起始页码，从 1 开始，默认为 1 **PageSize** integer `示例值：10` 分页查询时每页显示的记录数，取值： * 最小值：1 * 最大值：100 * 默认值：10 **Items** object[] `示例值：\-` 精简版接入点信息 **Id** string 接入点的ID **Name** string 接入点名称 **StatusReason** string 状态附加说明信息 **RateLimit** object 接入点限流 **Tpm** integer 每分钟 token 数量 **Rpm** integer 每分钟请求数 **Ipm** integer 每分钟图片数量 **FastTpm** integer 每分钟低延迟 token 数量。仅对已适配低延迟能力的模型生效，未启用时可忽略该字段。支持低延迟的模型请在[开通管理](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D)中查看。 **CreateTime** string 接入点创建时间，RFC3339格式 **UpdateTime** string 接入点更新时间，RFC3339格式 **Status** string 接入点状态 **ModelUnitId** string 模型单元 **ModelReference** object 接入点接入模型 **CustomModelId** string 定制模型的 ID **FoundationModel** object 基础模型 **Name** string 基础模型名称 **ModelVersion** string 基础模型版本 **Tags** object[] 接入点绑定的标签 **Key** string 标签键 **Value** string 标签值 **ProjectName** string 项目名称 **Description** string 接入点描述 **ContentGeneration** object 生图/生视频模型的特化配置 **ConcurrentRequests** long 并发请求数上限 **CreateTaskRpm** long 每分钟可创建的任务数上限 **ConcurrentRequestsFor4K** long 图像/视频 4K 生成任务的并发请求数上限。仅在支持 4K 生成的模型下生效。 **CreateTaskRpmFor4K** long 图像/视频 4K 生成任务每分钟创建数上限。仅在支持 4K 生成的模型下生效。 **EndpointModelType** string 接入点模型类型。取值: * FoundationModel：基础模型 * CustomModel：定制模型 **PaymentType** string Endpoint的付费方式。取值： * ModelUnit：模型单元 * ScaleTier：TPM保障包 * nil：Token付费 ## 请求示例 ```text 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" } ``` ## 返回示例 ```json { "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" } ] } } ``` ## 错误码您可访问[公共错误码](https://www.volcengine.com/docs/82379/1299023)，获取更多错误码信息。

火山方舟