获取云盘列表--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

边缘云盘

获取云盘列表

本接口用于查询已创建的云盘的列表。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListEbsInstances`	接口名称。当前 API 的名称为 `ListEbsInstances`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
with_attachment_info	Boolean	否	`true`	是否展示挂载资源的名称。取值范围： true：展示挂载资源的名称。 false（默认值）：不展示挂载资源的名称。挂载资源的类型和ID默认展示。仅资源名称的展示受此参数控制。
res_ids	String[]	否	`veen1020125208252511****`	云盘所挂载的边缘实例的 ID。
ebs_ids	String[]	否	`disk-tvs2gmln****`	云盘的 ID。
ebs_names	String[]	否	`cloud_disk_01`	云盘的名称。
regions	String[]	否	`SouthChina`	云盘所属的区域。取值范围： SouthChina：华南 EastChina：华东 Southwest：西南 Northwest：西北 NorthChina：华北 Northeast：东北 CentralChina：华中
cluster_names	String[]	否	`**cu01`	云盘所属的节点的名称。
status	String[]	否	`detached`	云盘的状态。取值范围： creating：创建中 detached：未挂载 attaching：挂载中 attached：已挂载 detaching：卸载中 scaling：扩容中 deleting：删除中 error：错误当云盘创建或挂载耗费时长超过 5 分钟后，云盘状态被置为 error。出现该情况时，您可以提交工单进行咨询。
ebs_type	String[]	否	`data`	云盘的类型。取值范围： data：数据盘。 system：系统盘。
charge_type	String[]	否	`configuration_monthly`	云盘的计费类型。取值范围： HourUsed：按量计费。 MonthlyPeak：月峰值计费。 DailyPeak：日峰值计费。 PrePaid：包年包月。 configuration_monthly：按配置月结。 configuration_hourly：按配置小时结。
delete_with_res	String	否	`true`	“随实例删除”功能是否开启。取值范围： true：“随实例删除”功能开启。 false：“随实例删除”功能关闭。
projects	String[]	否	`default`	云盘所属的项目。
TagFilters	Object[]	否	`-`	标签过滤器。
page_option	Object	否	`-`	分页查询设置。
order_option	Object	否	`-`	排序设置。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结果。

参数	类型	示例值	描述
ebs_instances	Object[]	`-`	云盘的列表。
total_cnt	Integer	`5`	云盘的数量。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListEbsInstances&Version=2021-04-30
&<其他公共参数>
{
    "with_attachment_info": true,
    "res_ids": [
        "veen0522220112101114****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401251656520B93E636B479205C****",
        "Action": "ListEbsInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "ebs_instances": [
            {
                "account_id": 210006****,
                "ebs_id": "disk-25mdrqmd5nd****",
                "ebs_name": "test12",
                "status": "attached",
                "cluster": {
                    "cluster_name": "**ct03",
                    "country": "CN",
                    "region": "NorthChina",
                    "province": "TJ",
                    "city": "120000",
                    "isp": "CTCC",
                    "alias": "**电信03"
                },
                "storage_type": "CloudBlockSSD",
                "capacity": "20",
                "ebs_type": "data",
                "charge_type": "configuration_monthly",
                "desc": "",
                "attachment": {
                    "ebs_id": "disk-25mdrqmd5nd****",
                    "res_type": "veen",
                    "res_id": "veen0522220112101114****",
                    "res_name": ""
                },
                "delete_with_res": false,
                "project": "default",
                "create_by_res": false,
                "status_reason": "",
                "start_time": 1706167826,
                "create_time": 1706167825,
                "update_time": 1706167837
            },
            {
                "account_id": 210006****,
                "ebs_id": "disk-gxs44vr2wp2****",
                "ebs_name": "test_yx",
                "status": "attached",
                "cluster": {
                    "cluster_name": "**ct03",
                    "country": "CN",
                    "region": "NorthChina",
                    "province": "TJ",
                    "city": "120000",
                    "isp": "CTCC",
                    "alias": "**电信03"
                },
                "storage_type": "CloudBlockSSD",
                "capacity": "30",
                "ebs_type": "data",
                "charge_type": "configuration_monthly",
                "desc": "",
                "attachment": {
                    "ebs_id": "disk-gxs44vr2wp2****",
                    "res_type": "veen",
                    "res_id": "veen0522220112101114****",
                    "res_name": ""
                },
                "delete_with_res": false,
                "project": "default",
                "create_by_res": false,
                "pvc_ns": "",
                "pvc_name": "",
                "status_reason": "",
                "start_time": 1705391772,
                "create_time": 1705391770,
                "update_time": 1706171929
            }
        ],
        "total_cnt": 2
    }
}

错误码

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

最近更新时间：2025.12.22 17:43:08

这个页面对您有帮助吗？

有用

无用