You need to enable JavaScript to run this app.
导航
获取边缘应用列表
最近更新时间:2023.10.11 10:11:22首次发布时间:2023.02.22 17:09:42

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

请求参数

名称

类型

是否必选

示例值

描述

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

边缘应用列表的页码。

  • 若未指定 pagelimit 参数:返回全量数据;
  • 若仅指定 page,未指定 limit:返回全量数据;
  • 若仅指定 limit,未指定 page :返回第 1 页数据;
  • 若指定 pagelimit :返回符合条件的数据。

limit

Int32

10

分页查询时设置的每页行数。

  • 若未指定 pagelimit 参数:返回全量数据;
  • 若仅指定 page,未指定 limit:返回全量数据;
  • 若仅指定 limit,未指定 page :返回第 1 页数据;
  • 若指定 pagelimit :返回符合条件的数据。

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
  }
}