获取模型供应商列表 - ListModelVendors
功能介绍
获取模型供应商列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/model-vendors
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
参数解释: 供应商类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
sort_key |
否 |
String |
参数解释: 排序规则,目前默认创建时间降序。 约束限制: 不涉及 取值范围:
默认取值: update_time |
|
sort_dir |
否 |
String |
参数解释: 排序方向。 约束限制: 不涉及 取值范围:
默认取值: desc |
|
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量。 约束限制: 不涉及 取值范围: [1-1000] 默认取值: 100 |
|
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移。 约束限制: 不涉及 取值范围: [0-100000000] 默认取值: 0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
model_vendors |
Array of ModelVendor objects |
参数解释: 模型供应商列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
count |
Integer |
参数解释: 模型供应商个数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 模型供应商ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
name |
String |
参数解释: 模型供应商名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
name_en |
String |
参数解释: 模型供应商英文名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
type |
String |
参数解释: 模型供应商类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
status |
String |
参数解释: 模型服务状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
create_time |
String |
参数解释: 模型供应商创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
update_time |
String |
参数解释: 模型供应商修改时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
description |
String |
参数解释: 模型供应商描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
auth_type |
String |
参数解释: 鉴权类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
auth_info |
VendorAuthInfo object |
参数解释: 鉴权信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
auth_url |
String |
参数解释: 内置供应商获取鉴权信息地址。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取模型供应商列表。
https://{endpoint}/v1/{project_id}/model-vendors
响应示例
状态码:200
OK
{
"count" : 1,
"model_vendors" : [ {
"id" : "b12a534c-ecb2-5445-a9a2-4fd9b1e4e4e6",
"name" : "deepseek",
"name_en" : "deepseek",
"type" : "CUSTOM",
"status" : "AVAILABLE",
"create_time" : "2025-01-29T02:34:36Z",
"update_time" : "2025-01-30T02:34:36Z",
"description" : "deepseek",
"auth_type" : "API_KEY",
"auth_info" : {
"api_key" : "your api_key"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。