ListDeployment - 获取无状态工作负载列表--边缘智能-火山引擎

文档中心

立即注册

导航

ListDeployment - 获取无状态工作负载列表

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

调用本接口获取无状态工作负载列表。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListDeployment	要执行的操作，取值：ListDeployment。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
page_index	Integer	是	1	设置要返回的页码。工作负载默认按照创建时间降序排列。您可以设置 created_orderby 或 updated_orderby 来修改排序方式。
page_size	Integer	是	10	设置单页包含的最大工作负载数。
created_orderby	Integer	否	0	按创建时间对工作负载排序。该参数有以下取值： 0（默认）：按创建时间降序 1：按创建时间升序
updated_orderby	Integer	否	0	按更新时间对工作负载排序。该参数有以下取值： 0：按更新时间降序 1：按更新时间升序
app_name	String	否	test	使用工作负载名称进行模糊查询。
nodes	Array of String	否	["sxn012-bdvbaz"]	工作负载部署到的节点ID列表。
template_ids	Array of String	否	["at-2100001281-cgpdt"]	工作负载使用的应用模板ID列表。
biz_line	Array of Integer	否	1	工作负载的类型（即关联的业务）。该参数有以下取值： 0：用户自定义（您手动创建） 1：模型服务 2：设备驱动 3：数据流实例 5：Helm chart
biz_deployment	Boolean	否	false	是否返回业务关联的工作负载。默认值：false，表示仅返回用户自定义（您手动创建的）工作负载。业务关联的工作负载表示因部署其他模块服务时，系统自动创建的工作负载。例如，您部署了一个模型服务，那么系统自动创建相应的工作负载，该工作负载关联“模型服务”业务。
project_id	String	否	p-2100001281-zf9ll	工作负载所属边缘智能项目ID。

返回参数

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

参数	类型	示例值	描述
pageinator	Object		分页信息。
items	Array of Object		工作负载对象列表。

请求示例

POST /?Action=ListDeployment&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250402T093236Z
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,
  "project_id": "p-2100001281-zf9ll"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250402173321129037233071D05827",
    "Action": "ListDeployment",
    "Version": "2022-01-01",
    "Service": "vei_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "pageinator": {
      "index": 1,
      "size": 10,
      "total_pages": 1,
      "total_items": 1
    },
    "items": [
      {
        "deployment_id": "di-2100001281-69chb",
        "project_id": "p-2100001281-zf9ll",
        "name": "my_deployment",
        "desc": "doctest-工作负载",
        "created_at": "1734338831",
        "updated_at": "1743584119",
        "status": {
          "replicas": 1,
          "updated_replicas": 1,
          "ready_replicas": 0,
          "available_replicas": "0"
        },
        "node": "sxn012-bdvbaz",
        "related_template": {
          "name": "我的应用模板",
          "template_id": "at-2100001281-cgpdt",
          "version_id": "atv-2100001281-9lvwp",
          "version_name": "应用模板版本1"
        },
        "project_name": "我的第一个项目",
        "hci_name": "节点A",
        "biz_line": 0
      }
    ]
  }
}

错误码

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