ListModel - 获取模型列表--边缘智能-火山引擎

文档中心

立即注册

边缘智能

边缘推理

ListModel - 获取模型列表

调用本接口获取模型信息列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListModel	要执行的操作，取值：ListModel。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
page_index	Integer	是	1	设置要返回的页码。模型默认按照创建时间降序排列。您可以设置 created_orderby 或 updated_orderby 来修改排序方式。
created_orderby	String	否	0	按创建时间对模型排序。该参数有以下取值： 0（默认）：按创建时间降序 1：按创建时间升序
updated_orderby	Integer	否	0	按更新时间对模型排序。该参数有以下取值： 0：按更新时间降序 1：按更新时间升序
page_size	Integer	是	10	设置单页包含的最大模型数。
kind	Integer	否	2	要查询的模型的类型。该参数有以下取值： 1（默认）：用户自定义模型（即您上传的模型） 2：平台官方模型
model_name	String	否	口罩检测	使用模型名称进行模糊查询。
project_id	String	否	p-2100001281-zf9ll	模型所属边缘智能空间ID。您可以调用ListProject接口获取所有边缘智能空间ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
pageinator	Object		分页信息。
kind	Integer	2	模型的类型。该参数有以下取值： 1：用户自定义模型 2：平台官方模型
items	Array of Object		模型对象列表。

请求示例

POST /?Action=ListModel&Version=2022-01-01 HTTP/1.1
Host: vei-api.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
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	90000015	The account is not authenticated by real name	账号未实名认证。
400	90000021	The account is not authorized to access project	越权访问其他账号下的空间。
400	30010001	参数字段为空	参数字段为空。
400	30010002	参数校验不合法	参数校验不合法。
400	30010004	数据不存在	数据不存在。
500	90000009	Internal service errors	服务内部错误。
500	30010003	Mongo数据库错误	Mongo数据库错误。

最近更新时间：2025.10.23 10:47:29

这个页面对您有帮助吗？

有用

无用