获取租户的Pod列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取租户的Pod列表

最近更新时间：2024.06.25 16:32:14首次发布时间：2024.04.15 11:08:05

本接口用于获取租户下的所有 Pod 的信息。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListAccountPods	要执行的操作。取值：ListAccountPods。
status	String	否	Running,Pending	Pod 状态，多个值时，用英文逗号分隔。取值范围： Pending：等待中 Running：运行中 Terminating：删除中 Succeeded：成功 Failed：失败 Unknown：未知
pod_name	string	否	res-21212127127****	Pod 名称
public_ip	string	否	124.126..	公网 ip
inner_ip	string	否	192.168..	内网 ip
app_names	string	否	test-app	应用名称，多个值时，用英文逗号分隔。
app_ids	string	否	veecc-2200400020****	应用 ID，多个值时，用英文逗号分隔。
regions	string	否	EastChina	大区，多个值时，用英文逗号分隔。
cities	string	否	330200,330100	城市，多个值时，用英文逗号分隔。
isps	string	否	CTCC	运营商，多个值时，用英文逗号分隔。
cluster	string	否	海口联通网络测试集群	集群名称（中文名或英文名均可）。
page	int32	否	1	Pod 列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	int32	否	10	分页查询时设置的每页行数。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	int32	是	1	查询出来的 Pod 列表按创建时间的排列顺序。取值范围： 1：按照降序排列。 2：按照升序排列。

返回数据

参数	类型	示例值	描述
pods	[ ] PodInstance	请参见返回示例	Pod 列表。
total_count	int64	20	Pod 总数

请求示例

GET https://veecc.volcengineapi.com/?Action=ListAccountPods
&inner_ip=192.168.**.**
&limit=10
&page=1
&order_by=2
&<公共请求参数>

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240104142411178AA52F248FBD8****",
    "Action": "ListAccountPods",
    "Version": "2022-10-01",
    "Service": "veecc",
    "Region": "cn-north-1"
  },
  "Result": {
    "pods": [
      {
        "pod_name": "res-218818258111320021****",
        "app_id": "veecc-7715435870344851****",
        "app_name": "public-ip__副本1",
        "region": "EastChina",
        "city": "330200",
        "isp": "CTCC",
        "public_ips": [],
        "inner_ips": [
          "192.168.**.**",
          "fc00::**:**"
        ],
        "restart_count": 0,
        "start_time": 1702365816,
        "cluster_name": "nbct05-testing9",
        "cluster_alias": "nbct05-testing9",
        "status": "Running",
        "workload_id": "res-2188182581113200****",
        "app_version": "1.0.1",
        "pod_uid":"b7b8ed1e-7b9e-4b9f-87a5-35d4dfc8****",
        "spec_name": "veECC.MC1.0-1large"
      }
    ],
    "total_count": 1
  }
}

错误码

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