You need to enable JavaScript to run this app.
导航
ListMediapipeInstance - 获取数据流实例列表
最近更新时间:2025.04.22 15:34:59首次发布时间:2025.04.22 11:47:46
我的收藏
有用
有用
无用
无用

调用本接口获取数据流实例信息列表。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

ListMediapipeInstance

要执行的操作,取值:ListMediapipeInstance。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

page_index
Integer

1

设置要返回的页码。数据流实例默认按创建时间降序排序。

page_size
Integer

10

设置单页包含的最大实例数。

instance_name
String

test_ekuiper

要查询的数据流实例的名称。

statuses
Array of Integer

[3]

数据流实例的状态列表。状态有以下取值:

  • 1:未部署
  • 2:部署中
  • 3:运行中
  • 4:停用中
  • 5:部署失败
  • 6:正在删除
engine_types
Array of Integer

[1]

数据流实例的执行框架类型列表。执行框架有以下取值:

  • 1:DEEPSTREAM
  • 2:DLSTREAMER
  • 101:EKUIPER
hci_names
Array of String

["L4V5********7SC1"]

数据流实例所在节点ID列表。

hci_alias
Array of String

["nodeA"]

数据流实例所在节点别名列表。

project_ids
Array of String

["p-2100001281-zf9ll"]

数据流实例所属边缘智能项目ID列表。

返回参数

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

参数
类型
示例值
描述
pageinator
Object

分页信息。

items
Array of Object

数据流实例对象。

请求示例

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

{
  "page_index": 1,
  "page_size": 10
}

返回示例

{
	"ResponseMetadata": {
		"RequestId": "202404181635401AB17B0034F06BC82044",
		"Action": "ListMediapipeInstance",
		"Version": "2022-01-01",
		"Service": "vei_api",
		"Region": "cn-beijing"
	},
	"Result": {
		"items": [{
			"template_name": "dlstreamer模板",
			"template_version_name": "测试",
			"kind": 1,
			"instance_id": "mpi-2100053947-9dl8n",
			"project_name": "测试",
			"create_time": "1713081525",
			"desc": "",
			"template_id": "mpt-2100053947-kqgk2",
			"instance_name": "tesla_dlsteamer_20240414_155844",
			"project_id": "p-2100053947-lkntb",
			"resource": {
				"gpu_num": 0,
				"cpu_request": 0,
				"cpu_limit": 0,
				"mem_request": 0,
				"mem_limit": 0
			},
			"hci_alias": "test",
			"engine_type": 2,
			"update_time": "1713429336",
			"template_version_id": "mpv-2100053947-n2vgh",
			"is_debuging": false,
			"hci_name": "sxg002-bv69b1",
			"status": 3,
			"latest_failure_reason": ""
		}],
		"pageinator": {
			"index": 1,
			"size": 10,
			"total_pages": 1,
			"total_items": 1
		}
	}
}

错误码

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