调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListDevice	要执行的操作，取值：ListDevice。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
vague_device_name	String	否	摄像头	使用设备名称进行模糊搜索。
tags	Array of Object	否		设备绑定的标签。
page_index	Integer	是	1	设置要返回的页码。设备默认按照创建时间降序排列。您可以设置 created_orderby 或 updated_orderby 来修改排序方式。
page_size	Integer	是	10	设置单页包含的最大设备数。
project_id	Array of String	否	["p-2100001281-zf9ll"]	设备所属边缘智能空间ID列表。您可以调用ListProject接口获取所有边缘智能空间ID。
driver_template_name	Array of String	否	["device-onvif-camera"]	设备使用的驱动模板名称列表。
node_name	Array of String	否	["sxn012-bdvbaz"]	设备所连接的节点ID列表。
status	Array of Integer	否	1	设备状态。该参数有以下取值： 0：未激活 1：在线 2：离线 3：创建中 4：创建失败 5：删除中 6：删除失败 7：更新中 8：更新失败
profile_category	Array of String	否	1	设备模板类型。该参数有以下取值： 0：其他设备 1：视频流设备
created_orderby	Integer	否	0	按创建时间对设备排序。该参数有以下取值： 0（默认）：按创建时间降序 1：按创建时间升序
updated_orderby	Integer	否	0	按更新时间对设备排序。该参数有以下取值： 0：按更新时间降序 1：按更新时间升序

返回参数

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

参数	类型	描述
items	Array of Object	设备对象列表。
overview	Object	设备状态信息总览。
pageinator	Object	分页信息。

请求示例

POST /?Action=ListDevice&Version=2022-01-01 HTTP/1.1
Host: vei-api.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250417T094406Z
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
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230616163250741626A7C2A7C1FD6E5C",
        "Action": "ListDevice",
        "Version": "2022-01-01",
        "Service": "vei_api",
        "Region": "cn-north-1"
    },
    "Result": {
        "items": [
            {
                "device_id": "dv-2100055467-7xfbl",
                "device_name": "multiple-value",
                "description": "",
                "project_id": "p-2100055467-mkzzb",
                "project_name": "jq-mediapipe",
                "node_name": "sxg010-bd0003",
                "node_alias": "gpu3070",
                "profile_id": "dp-2100055467-6kcln",
                "profile_name": "multiple-things",
                "profile_category": 0,
                "driver_template_name": "device-virtual",
                "driver_template_alias": "虚拟驱动",
                "status": 1,
                "message": "",
                "created_at": "1686820316",
                "updated_at": "1686820396",
                "online_time": "1686820396",
                "pipeline_status": {
                    "iot": false,
                    "live": false
                }
            },
            {
                "device_id": "dv-2100055467-7wxv8",
                "device_name": "release-jq-ov",
                "description": "",
                "project_id": "p-2100055467-mkzzb",
                "project_name": "jq-mediapipe",
                "node_name": "sxg010-bd0003",
                "node_alias": "gpu3070",
                "profile_id": "dp-2100055467-2s9th",
                "profile_name": "jq-onvif",
                "profile_category": 1,
                "driver_template_name": "device-onvif-camera",
                "driver_template_alias": "ONVIF驱动",
                "status": 1,
                "message": "",
                "created_at": "1686733186",
                "updated_at": "1686733277",
                "online_time": "1686733277",
                "pipeline_status": {
                    "iot": false,
                    "live": false
                }
            },
            {
                "device_id": "dv-2100055467-hsp5d",
                "device_name": "jq-virtual",
                "description": "",
                "project_id": "p-2100055467-mkzzb",
                "project_name": "jq-mediapipe",
                "node_name": "sxg010-bd0003",
                "node_alias": "gpu3070",
                "profile_id": "dp-2100055467-958h4",
                "profile_name": "jq-message",
                "profile_category": 0,
                "driver_template_name": "device-virtual",
                "driver_template_alias": "虚拟驱动",
                "status": 1,
                "message": "",
                "created_at": "1686637593",
                "updated_at": "1686637668",
                "online_time": "1686637668",
                "pipeline_status": {
                    "iot": false,
                    "live": false
                }
            }
        ],
        "overview": {
            "total": 3,
            "online": 3,
            "offline": 0,
            "activated": 0,
            "unactivated": 0
        },
        "paginator": {
            "index": 1,
            "size": 10,
            "total_pages": 1,
            "total_items": 3
        }
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	681480	设备实例名称不合法	设备实例名称不合法。
400	681481	项目中存在同名的设备实例	空间中存在同名的设备实例。
400	681484	驱动实例未正常运行，无法添加设备	驱动实例未正常运行，无法添加设备。
400	681483	找不到对应的设备实例	找不到对应的设备实例。
400	681482	设备实例名称不允许变更	设备实例名称不允许变更。

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

这个页面对您有帮助吗？

有用

无用

边缘智能

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码