查询供应商模板列表 - ListProviderTemplates
功能介绍
获取内置供应商模板列表(hw_maas、deepseek)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
workspace:modelProvider:list
List
-
-
-
-
URI
GET /v3/ai-agents/model-provider-templates
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| templates | Array of ProviderTemplateInfo objects | 供应商模板列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| provider_type | String | 模板唯一标识(供应商类型)。 |
| provider_id | String | 供应商id。 |
| base_url | String | 供应商base_url。 |
| custom_config | ProviderCustomConfig object | 自定义配置内容。 |
| api_type | String | API协议类型(OpenAI/Anthropic)。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| model_list_api | String | 模型列表接口地址,用于查询供应商远程模型。 |
| auth_header | String | 认证请求头名称。 |
| auth_prefix | String | 认证前缀(如Bearer)。 |
| model_id_field | String | 供应商模型列表中模型ID字段名。 |
| model_name_field | String | 供应商模型列表中模型名称字段名。 |
| headers | Map<String,String> | 自定义HTTP请求头,调用供应商API时附加。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述,遵循三段式格式:{描述}.{原因}.{方案}。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述,遵循三段式格式:{描述}.{原因}.{方案}。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述,遵循三段式格式:{描述}.{原因}.{方案}。 |
状态码:500
请求示例
GET /v3/ai-agents/model-provider-templates
响应示例
状态码:200
操作成功。
{
"templates" : [ {
"provider_type" : "hw_maas",
"provider_id" : "provider-uuid-001",
"base_url" : "https://api-ap-southeast-1.modelarts-maas.com/v2",
"custom_config" : {
"model_list_api" : "https://api-ap-southeast-1.modelarts-maas.com/v2/models",
"auth_header" : "Authorization",
"auth_prefix" : "Bearer",
"model_id_field" : "id",
"model_name_field" : "id"
},
"api_type" : "OpenAI"
}, {
"provider_type" : "deepseek",
"provider_id" : "provider-uuid-002",
"base_url" : "https://api.deepseek.com/v2",
"custom_config" : {
"model_list_api" : "https://api.deepseek.com/v2/models",
"auth_header" : "Authorization",
"auth_prefix" : "Bearer",
"model_id_field" : "id",
"model_name_field" : "id"
},
"api_type" : "OpenAI"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功。 |
| 400 | 由于包含语法错误,当前请求无法被服务器理解。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 500 | 服务内部异常。 |
错误码
请参见错误码。