You need to enable JavaScript to run this app.
导航

获取集群列表

最近更新时间2023.08.14 16:44:51

首次发布时间2023.02.15 19:04:54

本接口用于根据函数域名获取集群列表。

请求参数

名称位置类型是否必填示例值描述
ActionQueryStringListCluster要执行的操作。取值:ListCluster
domainQueryStringtest-sparrow.test.test函数域名
regionsQueryString华东大区,华南大区区域
  • 输入字符串,以','作为分隔符
citiesQueryString北京市,廊坊市城市
  • 输入字符串,以','作为分隔符
pageQueryInt321页码
limitQueryInt3210每页条数
order_byQueryInt322数据顺序,1为降序,2为升序(默认按照id的升序排列)

返回数据

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

Cluster

名称类型示例值描述
regionString东北大区区域
cityString上海市城市
cluster_aliasString电信集群别名
cluster_nameStringtest-local集群名称
vipString127.0.0.1IP
cluster_typeInt32100集群类型
  • 100为灰度集群
  • 200为全量集群
trafficsString[{"version_tag":"1.0.9"}]当前版本

请求示例

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

返回示例

正常返回示例

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