查看模型压缩任务列表
更新时间：2024-11-08
功能介绍
本接口用于查看模型压缩任务列表。
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址： https://qianfan.baidubce.com/v2/model
请求方式： POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值：application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeModelCompTasks |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| marker | string | 否 | 本次查询的起始位置加速任务id，说明： （1）默认从第一条数据开始 （2）示例值：amva-n50985crhqq3 |
| maxKeys | int | 否 | 返回的列表长度，说明： （1）最大为100；如果指定的值大于100，按100操作 （2）默认值是10 |
| pageReverse | bool | 否 | 是否倒序，可选值： · true：是 · false：否，默认为false |
| sourceModelId | string | 否 | 模型版本ID，用于筛选特定模型版本的压缩任务，通过以下方式获取该字段值： · 方式一，通过调用新建我的模型版本接口，返回的modelId字段获取 · 方式二，在控制台-我的模型-点击某模型详情，在版本列表中查看  |
响应说明
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| code | string | 错误码，接口报错时返回，HTTP状态码>=400 |
| message | string | 错误信息，接口报错时返回，HTTP状态码>=400 |
| result | object | 请求结果 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| modelCompTaskList | list[modelCompTaskItem] | 模型压缩任务列表 |
| pageInfo | object | 分页信息 |
modelCompTaskItem说明
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 模型压缩任务ID |
| name | string | 模型压缩任务名称 |
| description | string | 模型压缩任务描述 |
| status | string | 模型压缩任务运行状态，说明： · creating：创建中 · running：运行中 · succeeded：已完成 · failed：已失败 · stopping：终止中 · stopped：已终止 |
| sourceModelId | string | 模型压缩任务源模型id |
| modelId | string | 压缩后产出模型id；当任务失败，该字段为空 |
| createTime | time | 任务创建时间 |
| finishTime | time | 任务完成时间 |
pageInfo说明
| 名称 | 类型 | 描述 |
|---|---|---|
| marker | string | 本次查询的起始位置 |
| maxKeys | int | 请求返回的最大数目 |
| isTruncated | bool | 指明是否只返回了部分数据，说明： · false：表示本次已经返回所有结果 · true：表示本次还没有返回所有结果 |
| nextMarker | string | 当isTruncated为true时，返回该字段，作为下次查询marker的值 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=DescribeModelCompTasks'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21axxxxxe374525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"marker":"amva-n50985crhqq3"
}'响应示例
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"modelCompTaskList": [
{
"id": "amva-j05zi5ebfqf1",
"name": "demo",
"description": "test",
"status": "succeeded",
"sourceModelId": "amv-m45zi5edgff1",
"modelId": "amv-s4678i5edgff",
"config": {
"strategy": "Quantization",
"quantConf": "wint8"
},
"createTime": "2024-03-22T17:13:33+08:00"
}
],
"pageInfo":{
"marker":"amva-n50985crhqq3",
"maxKeys":1,
"isTruncated":false
}
}
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考查看模型压缩任务列表。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。