获取工作负载列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取工作负载列表

最近更新时间：2024.06.25 16:32:14首次发布时间：2023.02.22 17:09:42

本接口用于获取工作负载列表。

请求说明

请求方式：GET
请求地址：https://veecc.volcengineapi.com/?Action=ListWorkloads&Version=2022-10-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListWorkloads	要执行的操作。取值：ListWorkloads。
application_identity	String	是	veecc-4000252292242221****	边缘应用 ID。
name	String	否	工作负载1	工作负载名称，模糊匹配。
identity	String	否	res-6910460211010082****	工作负载 ID，模糊匹配。
page	Int32	否	1	工作负载列表的页码，最小为1。若未指定 page 和 limit 参数：返回全量数据；若仅指定 page，未指定 limit：返回全量数据；若仅指定 limit，未指定 page ：返回第 1 页数据；若指定 page 和 limit ：返回符合条件的数据。
limit	Int32	否	10	分页查询时设置的每页行数。若未指定 page 和 limit 参数：返回全量数据；若仅指定 page，未指定 limit：返回全量数据；若仅指定 limit，未指定 page ：返回第 1 页数据；若指定 page 和 limit ：返回符合条件的数据。
order_by	Int32	是	1	查询出来的工作负载的按创建时间的排列顺序。取值范围： 1：按照降序排列。 2：按照升序排列。
version_no	String	否	1.0.0	工作负载版本号，默认取值为 latest。

返回参数

参数	类型	示例值	描述
workloads	[ ]WorkloadResp	请参见返回示例	工作负载列表。
total_count	Int64	100	工作负载总数。

请求示例

GET https://veecc.volcengineapi.com/?Action=ListWorkloads
&application_identity=veecc-3728752022535555****
&page=1
&limit=10
&order_by=1
&<公共请求参数>

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2021102215554401022511001102AB****",
    "Action": "ListWorkloads",
    "Version": "2022-10-01",
    "Service": "veecc",
    "Region": "cn-north-1"
  },
  "Result": {
    "workloads": [
      {
        "identity": "res-2280220251525133****",
        "name": "wwww11****",
        "type": 1,
        "spec_name": "veECC.C1.4-8large",
        "remark": "",
        "deploy_strategy": 2,
        "rolling_size": 1,
        "max_disable_size": 1,
        "enable_nat": false, 
        "bandwidth_billing_method": "DailyPeak",
        "workload_access": {
          "access_public_network": true,
          "access_type": 1,
          "access_services": null
        },
        "create_time": 1661239676,
        "update_time": 1663728754,
        "spec_info": {
          "spec_name": "veECC.C1.4-8large",
          "cpu": "4.0",
          "mem": "8GB",
          "pps": "4000000",
          "bandwidth": "30000M"
        },
        "workload_storage_volumes": [
          {
            "identity": "res-0239259020990231****",
            "name": "aa",
            "class": 1,
            "type": 4,
            "capacity": 2000
          }
        ],
      }
    ],
    "total_count": 1
  }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见公共错误码。