1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
模型列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTrainingModels。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 否 | Array of Filter | 过滤器 Filter.Name: 枚举值: keyword (模型名称) TrainingModelId (模型ID) ModelVersionType (模型版本类型) 其值Filter.Values支持: NORMAL(通用) ACCELERATE (加速) TrainingModelSource (模型来源) 其值Filter.Values支持: JOB/COS ModelFormat(模型格式)其值Filter.Values支持: PYTORCH/TORCH_SCRIPT/DETECTRON2/SAVED_MODEL/FROZEN_GRAPH/PMML/MMDETECTION/ONNX/HUGGING_FACE Filter.Values: 当长度为1时,支持模糊查询; 不为1时,精确查询 每次请求的Filters的上限为10,Filter.Values的上限为100 Filter.Fuzzy取值:true/false,是否支持模糊匹配 |
OrderField | 否 | String | 排序字段,默认CreateTime 示例值:CreateTime |
Order | 否 | String | 排序方式,ASC/DESC,默认DESC 示例值:DESC |
Offset | 否 | Integer | 偏移量 示例值:0 |
Limit | 否 | Integer | 返回结果数量 示例值:10 |
TagFilters.N | 否 | Array of TagFilter | 标签过滤 |
WithModelVersions | 否 | Boolean | 是否同时返回模型版本列表 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TrainingModels | Array of TrainingModelDTO | 模型列表 |
TotalCount | Integer | 模型总数 示例值:4 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 模型列表请求
模型列表请求
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTrainingModels
<公共请求参数>
{
"Filters": [
{
"Fuzzy": false,
"Values": [
"NORMAL"
],
"Name": "ModelVersionType",
"Negative": false
}
],
"TagFilters": [
{
"TagValues": [
"test-value"
],
"TagKey": "test-key"
}
],
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"TrainingModels": [
{
"TrainingModelId": "m-660879334503305216",
"TrainingModelName": "test-model",
"Tags": [
{
"TagKey": "test-key",
"TagValue": "test-value"
}
],
"CreateTime": "2022-11-17 20:09:16",
"TrainingModelVersions": []
}
],
"TotalCount": 1,
"RequestId": "ced11c16-fd5a-4f12-8a0b-17c7f0b14659"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.CamException | CAM系统异常。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.ExecDatabaseFail | 数据库执行错误。 |
FailedOperation.ExecTagFail | 标签操作失败。 |
FailedOperation.QueryBindingTagsFailed | 查询资源标签失败。 |
FailedOperation.QueryDatabaseFail | 数据库查询错误。 |
FailedOperation.QueryModelsByTagsFailed | 根据标签查询资源失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnknownParameter | 未知参数错误。 |