获取集群列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取集群列表

最近更新时间：2024.07.05 16:58:25首次发布时间：2023.02.15 19:04:54

本接口用于获取集群列表。

请求说明

请求方式：GET
请求地址：https://veefedge.volcengineapi.com/?Action=ListCluster&Version=2021-04-30

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListCluster	公共参数。该参数表示接口名称。取值：ListCluster
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
domain	String	是	bc36dc7c50b9f125d186df****	函数ID
regions	String	否	华东大区,华南大区	区域输入字符串，以','作为分隔符
cities	String	否	北京市,廊坊市	城市输入字符串，以','作为分隔符
page	Int32	否	1	页码
limit	Int32	否	10	每页条数
order_by	Int32	否	2	数据顺序，1为降序，2为升序(默认按照id的升序排列)

返回参数

参数	类型	示例值	描述
clusters	[]Cluster	见下文说明	集群列表

Cluster

参数	类型	示例值	描述
region	String	东北大区	区域
city	String	上海市	城市
cluster_alias	String	电信	集群别名
cluster_name	String	test-local	集群名称
vip	String	127.0.0.1	IP
cluster_type	Int32	100	集群类型 100为灰度集群 200为全量集群
traffics	String	[{"version_tag":"1.0.9"}]	当前版本

请求示例

GET https://veefedge.volcengineapi.com/?Action=ListCluster
&domain=bc36dc7c50b9f125d186df****
&<公共请求参数>

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022022017233901022524315305*****",
        "Action": "ListCluster",
        "Version": "2021-04-30",
        "Service": "veefapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "clusters": [
            {
                "region": "华南大区",
                "city": "海口市",
                "cluster_alias": "电信",
                "cluster_name": "test-local",
                "vip": "",
                "cluster_type": 100,
                "traffics": "[{\"version_tag\":\"1.0.11\"}]"
            }
        ],
        "total_count": 1
    }
}

错误码

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