查询端点列表
功能介绍
列举端点列表。用户可使用该接口列举工作空间下端点列表,支持输入模型id、端点id、名称、类型、可见性等参数过滤,支持分页查询。此接口为同步接口,无配套使用接口和特殊场景。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET https://localhost.com/v1/workspaces/{workspace_id}/endpoints
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace_id |
是 |
String |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
|
limit |
否 |
Integer |
|
model_id |
否 |
String |
|
name |
否 |
String |
|
endpoint_id |
否 |
String |
|
type |
否 |
Object |
|
visibility |
否 |
String |
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
|
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
|
endpoints |
Array of EndpointBriefInfo objects |
|
参数 |
参数类型 |
描述 |
---|---|---|
visibility |
String |
|
id |
String |
|
name |
String |
|
type |
String |
|
status |
String |
|
description |
String |
|
create_time |
String |
|
update_time |
String |
|
owner |
User object |
|
cap |
CapRef object |
|
reserved_resource |
ReservedResource object |
|
ray_resource |
RayResourceInfo object |
|
caches |
Array of CacheConfig objects |
|
error_code |
String |
|
error_msg |
String |
|
参数 |
参数类型 |
描述 |
---|---|---|
domain_name |
String |
|
domain_id |
String |
|
user_name |
String |
|
user_id |
String |
|
参数 |
参数类型 |
描述 |
---|---|---|
cap_id |
String |
|
version_id |
String |
|
参数 |
参数类型 |
描述 |
---|---|---|
apu |
ResourceDef object |
|
dpu |
SqlResourceDef object |
|
mu |
ResourceDemand object |
|
参数 |
参数类型 |
描述 |
---|---|---|
spec_code |
String |
|
warm_up_num |
Integer |
|
max_num |
Integer |
|
参数 |
参数类型 |
描述 |
---|---|---|
spec_code |
String |
|
warm_up_num |
Integer |
|
max_num |
Integer |
|
use_public_resource |
Boolean |
|
参数 |
参数类型 |
描述 |
---|---|---|
spec_code |
String |
|
min |
Integer |
|
max |
Integer |
|
参数 |
参数类型 |
描述 |
---|---|---|
head_group_spec |
HeadGroupSpec object |
|
worker_group_spec |
Array of WorkerGroupSpec objects |
|
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
|
spec_code |
String |
|
min_replicas |
Integer |
|
max_replicas |
Integer |
|
参数 |
参数类型 |
描述 |
---|---|---|
mnt_path |
String |
|
cache_ins_id |
String |
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:408
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
请求示例
GET https://{endpoint}/v1/workspaces/{workspace_id}/endpoints
响应示例
状态码:200
查询Endpoint列表的响应体。
{
"total" : 1,
"endpoints" : [ {
"visibility" : "PRIVATE",
"id" : "0b5633ba2b904511ad514346f4dxxxxx",
"name" : "endpoint1",
"type" : "job",
"status" : "CREATING",
"description" : "description",
"create_time" : "2023-05-30T12:24:30.401Z",
"update_time" : "2023-05-30T12:24:30.401Z",
"owner" : {
"domain_name" : "string",
"domain_id" : "0b5633ba2b904511ad514346f4dxxxxx",
"user_name" : "string",
"user_id" : "0b5633ba2b904511ad514346f4xxxxx"
},
"cap" : {
"cap_id" : "0b5633ba2b904511ad514346f4xxxxx",
"version_id" : "0b5633ba2b904511ad514346f4xxxxx"
},
"reserved_resource" : {
"apu" : {
"spec_code" : "a1x",
"warm_up_num" : 1,
"max_num" : 100
},
"dpu" : {
"spec_code" : "d1x",
"warm_up_num" : 1,
"max_num" : 100,
"use_public_resource" : false
},
"mu" : {
"spec_code" : "mu",
"min" : 0,
"max" : 1
}
},
"ray_resource" : {
"head_group_spec" : {
"spec_code" : "string"
},
"worker_group_spec" : [ {
"name" : "string",
"spec_code" : "string",
"min_replicas" : 10000,
"max_replicas" : 10000
} ]
},
"caches" : [ {
"mnt_path" : "string",
"cache_ins_id" : "string"
} ],
"error_code" : "string",
"error_msg" : "string"
} ]
}
状态码:400
BadRequest
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}
状态码:401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码:403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
},
"error_code" : 403,
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
}
状态码:408
Request Time-out
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
}
状态码:500
InternalServerError
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
}
状态码
状态码 |
描述 |
---|---|
200 |
查询Endpoint列表的响应体。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
408 |
Request Time-out |
500 |
InternalServerError |
错误码
请参见错误码。