1、接口描述
获取租户可用的全部模型
2、请求方法
GET
3、接口要求
无
4、URI
/openapi/v1/models/list
5、请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| tenantId | 是 | String | 租户ID | abcb82293b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪。 | ||
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 | ||
| host | 是 | String | 终端节点域名，固定字段 | ||
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 |
6、请求代码示例
Curl -X GET "https://kqa-global.ctapi.ctyun.cn/openapi/v1/models/list"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "tenantId:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:kqa-global.ctapi.ctyun.cn"
7、返回值说明
1.请求成功返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | 是 | String | 200表示成功 | 200 | |
| message | 是 | String | 固定为Success | Success | |
| returnObj | 是 | Object | 接口返回结果 | returnObj |
2.表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| id | 是 | String | 模型ID | - | |
| name | 是 | String | 模型名称 | - | |
| description | 是 | String | 模型介绍 | - | |
| modelType | 是 | String | 模型类型 | - | |
| isDefault | 是 | Boolean | 是否为默认模型 | - |
3.请求失败返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | 是 | String | 错误码，放置API对应的错误码 | 40001 | |
| message | 是 | String | 失败信息 | 缺少鉴权信息 | |
| error | 是 | String | 返回对应的错误码 | KQA_40001 | |
| statusCode | 是 | String | 错误码，放置API对应的错误码 | 40001 |
8、返回值示例
1.请求成功返回值示例
{
"statusCode": 200,
"message": "Success",
"returnObj": [
{
"id": "d5f09a41d4584715a5d94a4892411c0f",
"name": "DeepSeek-R1-Distill-Llama-70B",
"description": "DeepSeek-R1-Distill-Llama-70B",
"modelType": "预置模型：PRESET_MODEL",
"isDefault": true
}
]
}
2.请求失败返回值示例
{
"statusCode": "40004",
"error": "KQA_40004",
"message": "接口执行异常"
}
9、状态码
| http状态码 | 描述 |
| 200 | 表示请求成功 |
10、错误码说明
见6.1.3通用错误码
