获取边缘服务列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

获取边缘服务列表

最近更新时间：2024.07.08 16:21:00首次发布时间：2022.02.25 18:58:31

本接口用于列出账号下的所有边缘服务信息。

请求说明

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

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListCloudServers	公共参数。该参数表示接口名称。取值：ListCloudServers。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
fuzzy_name	String	否	zcloud	边缘服务名称。支持模糊查询。
page	Integer	否	1	边缘服务列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	10	分页查询时设置的每页行数。默认值：10。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	1	查询出来的边缘服务的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

返回参数

参数	类型	示例值	描述
cloud_servers	[]CloudServer	请参见返回示例	边缘服务列表。
total_count	Integer	1	边缘服务个数。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListCloudServers&Version=2021-04-30
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230519191819D68A55F7D4AC5476****",
        "Action": "ListCloudServers",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "cloud_servers": [
            {
                "cloud_server_identity": "cloudserver-hgvbfwkpnsq****",
                "name": "cloud-test",
                "load_type": "virtual_machine",
                "server_area_count": 1,
                "instance_count": 1,
                "server_area_level": "city",
                "instance_status": [
                    {
                        "status": "running",
                        "instance_count": 1
                    }
                ],
                "spec_sum": {
                    "cpu": 2,
                    "data_disk": 20,
                    "mem": 8,
                    "sys_disk": 50
                },
                "spec": "veEN.G1.large",
                "spec_display": "通用型 | 2C8G",
                "cpu": "2",
                "mem": "8",
                "image": {
                    "image_identity": "imagepnjk4y****",
                    "image_name": "centos-7.3-amd64",
                    "system_arch": "Linux",
                    "system_type": "CentOS",
                    "system_bit": "64位",
                    "system_version": "7.3",
                    "property": "PublicBaseImage",
                    "disable_vga": false,
                    "image_boot_mode": "BIOS"
                },
                "storage": {
                    "system_disk": {
                        "storage_type": "CloudBlockSSD",
                        "capacity": "50"
                    },
                    "data_disk": {
                        "storage_type": "CloudBlockSSD",
                        "capacity": "20"
                    },
                    "data_disk_list": [
                        {
                            "storage_type": "CloudBlockSSD",
                            "capacity": "20"
                        }
                    ]
                },
                "network": {
                    "bandwidth_peak": "20",
                    "internal_bandwidth_peak": "500",
                    "dns_type": "default",
                    "dns_list": [
                        "114.114.114.114",
                        "180.184.1.1"
                    ]
                },
                "gpu": {
                    "gpus": []
                },
                "secret_config": {
                    "secret_type": 2
                },
                "custom_data": {
                    "is_base64": false,
                    "data": ""
                },
                "billing_config": {
                    "computing_billing_method": "MonthlyPeak",
                    "bandwidth_billing_method": "MonthlyP95"
                },
                "desc": "",
                "arch": "x86",
                "advanced_configuration": {
                    "instance_name": "",
                    "instance_desc": "",
                    "instance_host_name": "",
                    "delete_protection": false
                },
                "schedule_strategy_configs": {
                    "network_strategy": "city",
                    "schedule_strategy": "dispersion",
                    "price_strategy": "low_priority"
                },
                "server_areas": [
                    {
                        "area": "410300",
                        "isp": "CTCC",
                        "instance_num": 1,
                        "cluster_name": "****-lyct02",
                        "cluster_alias": "洛阳电信02"
                    }
                ],
                "create_time": 1684487349,
                "update_time": 1684487349
            }
        ],
        "total_count": 1
    }
}

错误码

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