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 "//kqa-global.ctapi.daliqc.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.daliqc.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通用錯誤碼