调用本接口获取模型信息列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListModel | 要执行的操作，取值：ListModel。 |
Version | String | 是 | 2022-01-01 | API的版本，取值：2022-01-01。 |
page_index | Integer | 是 | 1 | 设置要返回的页码。 |
created_orderby | String | 否 | 0 | 按创建时间对模型排序。该参数有以下取值：
|
updated_orderby | Integer | 否 | 0 | 按更新时间对模型排序。该参数有以下取值：
|
page_size | Integer | 是 | 10 | 设置单页包含的最大模型数。 |
kind | Integer | 否 | 2 | 要查询的模型的类型。该参数有以下取值：
|
model_name | String | 否 | 口罩检测 | 使用模型名称进行模糊查询。 |
project_id | String | 否 | p-2100001281-zf9ll | 模型所属边缘智能项目ID。
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
pageinator | Object | 分页信息。 | |
kind | Integer | 2 | 模型的类型。该参数有以下取值：
|
items | Array of Object | 模型对象列表。 |
POST /?Action=ListModel&Version=2022-01-01 HTTP/1.1 Host: open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20250417T091739Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250417/cn-beijing/vei_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "page_index": 1, "page_size": 10, "kind": 2, "model_name": "口罩检测" }
{ "ResponseMetadata": { "RequestId": "202504211426253162973277F93B34561D", "Action": "ListModel", "Version": "2022-01-01", "Service": "vei_api", "Region": "cn-beijing" }, "Result": { "items": [ { "model_id": "m-official-42", "model_name": "口罩检测-02-YOLOX-ONNX", "model_framework": 2, "update_time": "1728559378", "create_time": "1728559378", "online_num": 0, "offline_num": 0, "desc": "基于YOLOX的口罩检测ONNX模型", "kind": 2, "input": [ { "name": "images", "data_type": 12, "dims": [ 3, 640, 640 ] } ], "output": [ { "name": "output", "data_type": 12, "dims": [ -1, -1 ] } ], "model_versions": [ { "model_id": "m-official-42", "version_name": "v1", "deploy_num": 0, "desc": "", "create_time": "1728559378", "status": 2, "version_id": "mv-official-61", "able_delete": { "able": true }, "recommend_config": { "model_process": "mp-official-13", "max_batch_size": 4, "service_config": [ { "model_id": "m-official-42", "model_name": "口罩检测-02-YOLOX-ONNX", "cpu_count": 1, "gpu_count": 0 } ] }, "able_deploy": { "able": true }, "able_edit": { "able": false, "reasons": [ "当前版本已发布，不支持编辑" ] }, "able_release": { "able": false, "reasons": [ "当前版本已发布" ] }, "model_source": 1, "model_path": "/models/m-official-42" } ], "tags": [ { "tag_name": "object_detection", "display_name": "物体检测" } ], "enable_crypto": true, "doc_url": "https://www.volcengine.com/docs/6893/1347452", "able_delete": { "able": false, "reasons": [ "存在1个版本", "存在1个前后处理版本" ] }, "framework_name": "ONNX", "hardware_info": { "gpu_only": false, "arch": [ "amd", "arm" ] }, "clone_status": 1, "is_llm": false, "infer_framework_kind": 1 }, { "model_id": "m-official-1", "model_name": "口罩检测-01-PPLCNet-ONNX", "model_framework": 2, "update_time": "1722942672", "create_time": "1698837369", "online_num": 0, "offline_num": 0, "desc": "基于PaddlePaddle框架的PPLCNet口罩检测模型", "kind": 2, "input": [ { "name": "x", "data_type": 12, "dims": [ 3, 224, 224 ], "format": 1 } ], "output": [ { "name": "softmax_1.tmp_0", "data_type": 12, "dims": [ 2 ] } ], "model_versions": [ { "model_id": "m-official-1", "version_name": "v1", "deploy_num": 0, "desc": "", "create_time": "1698837369", "status": 2, "version_id": "mv-official-1", "able_delete": { "able": true }, "recommend_config": { "model_process": "mp-official-1", "max_batch_size": 4, "service_config": [ { "model_id": "m-official-1", "model_name": "口罩检测-01-PPLCNet-ONNX", "cpu_count": 1, "gpu_count": 0 } ] }, "able_deploy": { "able": true }, "able_edit": { "able": false, "reasons": [ "当前版本已发布，不支持编辑" ] }, "able_release": { "able": false, "reasons": [ "当前版本已发布" ] }, "model_source": 1, "model_path": "/models/m-official-1" } ], "tags": [ { "tag_name": "object_detection", "display_name": "物体检测" } ], "enable_crypto": true, "doc_url": "https://www.volcengine.com/docs/6893/1114021", "able_delete": { "able": false, "reasons": [ "存在1个版本", "存在1个前后处理版本" ] }, "framework_name": "ONNX", "hardware_info": { "gpu_only": false, "arch": [ "amd", "arm" ] }, "clone_status": 1, "is_llm": false, "infer_framework_kind": 1 } ], "pageinator": { "index": 1, "size": 10, "total_pages": 1, "total_items": 2 }, "kind": 2, "base_resp": { "StatusMessage": "", "StatusCode": 0 } } }
您可访问公共错误码，获取更多错误码信息。