获取边缘应用列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取边缘应用列表

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

本接口用于获取边缘应用列表。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListApplications	要执行的操作。取值：ListApplications。
name	String	否	name****	边缘应用名称，模糊匹配。
identity	String	否	veecc-****	边缘应用 ID，模糊匹配。
status	String	否	Normal,Abnormal	应用状态。多个值用英文逗号分隔。取值范围： Initialize：未部署 ScheduleFailed：调度失败 Deploying：部署中 Normal：正常 DeployFailed：部署失败 Terminating：删除中 Abnormal：异常
page	int32	否	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：按照升序排列。
order_key	String	否	create_time	排序字段，默认按照创建时间进行排序。取值范围： create_time：按照创建时间排序。 update_time：按照更新时间排序。

返回参数

参数	类型	示例值	描述
applications	[ ] ApplicationResp	请参见返回示例	应用列表。
total_count	Int64	100	应用总数。

请求示例

GET https://veecc.volcengineapi.com/?Action=ListApplications
&identity=veecc-2022000207700029****
&page=1
&limit=10
&order_by=1
&order_key=create_time
&<公共请求参数>

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2021102215554401022511001102AB****",
    "Action": "ListApplications",
    "Version": "2022-10-01",
    "Service": "veecc",
    "Region": "cn-north-1"
  },
  "Result": {
    "applications": [
      {
        "identity": "veecc-2022000207700029****",
        "name": "test_****",
        "remark": "",
        "billing_mode": 1,
        "workload_count": 1,
        "cluster_count": 1,
        "running_cluster_count": 0,
        "create_time": 1662555721,
        "update_time": 1662555920,
        "status": "ScheduleFailed"
      }
    ],
    "total_count": 1
  }
}

错误码

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