获取云盘详情--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

请输入

边缘云盘

获取云盘详情

本接口用于获取单个云盘的详细信息。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ebs_id	String	是	`disk-tvs2gmln****`	云盘的 ID。
with_attachment_info	Boolean	否	`true`	是否展示挂载资源的名称。取值范围： true：展示挂载资源的名称。 false（默认值）：不展示挂载资源的名称。挂载资源的类型和ID默认展示。仅资源名称的展示受此参数控制。

返回参数

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

参数	类型	示例值	描述
ebs_instance	Object	`请参见返回示例`	云盘的详情。

请求示例

POST https://veenedge.volcengineapi.com/?Action=GetEbsInstance&Version=2021-04-30
&<其他公共参数>
{
    "ebs_id": "disk-gxs44vr2wp2****",
    "with_attachment_info": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401251638277D06047285B75668****",
        "Action": "GetEbsInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "ebs_instance": {
            "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": "HourUsed",
            "desc": "",
            "attachment": {
                "ebs_id": "disk-25mdrqmd5nd****",
                "res_type": "veen",
                "res_id": "veen0522220112101114****"
            },
            "delete_with_res": false,
            "project": "default",
            "create_by_res": false,
            "status_reason": "",
            "start_time": 1706167826,
            "create_time": 1706167825,
            "update_time": 1706167837
        }
    }
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用