ListModelService - 获取模型服务列表--边缘智能-火山引擎

文档中心

立即注册

导航

ListModelService - 获取模型服务列表

最近更新时间：2025.04.22 15:34:59首次发布时间：2025.04.22 11:47:45

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListModelService	要执行的操作，取值：ListModelService。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
page_index	Integer	是	1	设置要返回的页码。模型服务默认按照创建时间降序排序。
page_size	Integer	是	10	设置单页包含的最大模型服务数。
name	String	否	test	使用模型服务名称进行模糊搜索。
node_id	String	否	sxn012-bdvbaz	指定模型服务所在节点ID。
status	Integer	否	1	指定要查询的模型服务的状态。该参数有以下取值： 1：运行中 2：部署中 3：部署失败 4：删除中
project_id	String	否	p-2100001281-zf9ll	指定模型服务所属项目ID。

返回参数

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

参数	类型	示例值	描述
pageinator	Object		分页信息。
items	Array of Object		模型服务对象列表。

请求示例

POST /?Action=ListModelService&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250402T120440Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250402/cn-beijing/vei_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "page_index": 1,
  "page_size": 10,
  "node_id": "sxn012-bdvbaz",
  "project_id": "p-2100001281-zf9ll"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250421141713B2B9833B7D6EB8E0E1F4",
    "Action": "ListModelService",
    "Version": "2022-01-01",
    "Service": "vei_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "items": [
      {
        "project_id": "p-2100001281-zf9ll",
        "service_name": "test",
        "version_name": "v1",
        "model_name": "owlv2_visual",
        "update_time": "1745215725",
        "create_time": "1744026411",
        "processor": "-",
        "model_framework": 2,
        "project_name": "我的第一个项目",
        "node": "nodeA",
        "status": 1,
        "service_id": "ms-2100053947-lm628",
        "debug_message": "",
        "model_id": "m-2100053947-6rrcz",
        "delete_info": {
          "able_delete": true
        },
        "tags": [
          {
            "tag_name": "object_detection",
            "display_name": "物体检测"
          }
        ],
        "k8s_service_url": {
          "grpcServiceURL": "ms-2100053947-lm628.p-2100053947-vzqk8:8001",
          "httpServiceURL": "ms-2100053947-lm628.p-2100053947-vzqk8:8000"
        },
        "compression": false,
        "able_call": {
          "able": true
        },
        "able_delete": {
          "able": true
        },
        "cross_node_type": 3,
        "node_id": "sxn012-bdvbaz",
        "framework_name": "ONNX",
        "able_edit": {
          "able": true
        },
        "node_status": "Online",
        "events": [
          {
            "unix_timestamp": "1744027566",
            "content": "开始部署"
          },
          {
            "unix_timestamp": "1744027566",
            "content": "镜像开始下载"
          },
          {
            "unix_timestamp": "1744027566",
            "content": "模型文件和依赖安装包开始下载"
          },
          {
            "unix_timestamp": "1744027567",
            "content": "镜像下载完成"
          },
          {
            "unix_timestamp": "1744027567",
            "content": "模型文件和依赖安装包下载完成"
          },
          {
            "unix_timestamp": "1744027589",
            "content": "部署成功"
          }
        ],
        "MediapipeInfo": {
          "mediapipe_num": 0
        },
        "replicas": 1,
        "deploy_config": {
          "nodes": [
            {
              "name": "nodeA",
              "id": "sxn012-bdvbaz"
            }
          ]
        }
      }
    ],
    "pageinator": {
      "index": 1,
      "size": 10,
      "total_pages": 1,
      "total_items": 1
    },
    "base_resp": {
      "StatusMessage": "",
      "StatusCode": 0
    }
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。