调用GetDbfs查询单个数据库文件系统_数据库文件存储(DBFS)-阿里云帮助中心

调用GetDbfs查询数据库文件系统详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dbfs:GetDbfs	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	DBFS 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
FsId	string	是	数据库文件系统 ID。	dbfs-GOrr********Yd0VLOyBpg

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
DBFSInfo	object	数据库文件系统实例。
Status	string	数据库文件系统的状态。取值范围： unattached 待挂载 attached 已挂载 creating 创建中 attaching 挂载中 detaching 卸载中 deleting 删除中 deleted 已删除 resizing 扩容中 snapshotting 快照中 upgrading 升级中	attached
PayType	string	数据库文件系统的付费类型，目前仅支持按量付费（postpaid）。	postpaid
FsId	string	数据库文件系统 ID。	dbfs-GOrr********Yd0VLOyBpg
Tags	object []	标签集合。
TagValue	string	标签值。	TestTagValue1
Id	integer	标签 ID。	1
TagKey	string	标签键。	TestTagKey1
SizeG	integer	数据库文件系统大小，单位 GiB。	20
EcsList	object []	挂载到的 ECS 实例集合。
EcsId	string	已挂载的 ECS 实例 ID。	i-y2vZ3********vvMilZ2hQ
RegionId	string	数据库文件系统所属的地域 ID。	cn-hangzhou
DBFSClusterId	string	数据库文件系统集群 ID。	c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD
Description	string	数据库文件系统描述信息。	desc
ZoneId	string	数据库文件系统所属的可用区 ID。	cn-hangzhou-i
FsName	string	数据库文件系统名称。	dbfs-test-01
Category	string	数据库文件系统类型。取值范围： standard：标准版 enterprise：企业版（公测中）	standard
CreatedTime	string	创建时间。	1609330367000
AttachNodeNumber	integer	数据库文件系统挂载的节点数。	1
KMSKeyId	string	KMS 密钥 ID。	c39EcDBf-2Ecb-C3C6-6526-018d4D******
Encryption	boolean	是否已加密。	false
PerformanceLevel	string	云盘性能等级。取值范围： PL0 PL1 PL2 PL3	PL1
UsedScene	string	使用场景。	MySQL 5.7
LastMountTime	string	最后挂载时间。	1644915400000
LastUmountTime	string	最后卸载时间。	1644915319000
EnableRaid	boolean	是否使能 RAID。	false
InstanceType	string	DBFS 实例规格。取值范围： dbfs.small dbfs.medium dbfs.large	dbfs.small
RaidStrip	integer	条数个数。	2
EbsList	object []	DBFS 使用的云盘列表。
EbsId	string	云盘 ID。	d-bp1hq4******qi7gy1th
SizeG	integer	云盘容量。单位 GiB。	20
LastFailed	string	最近一次操作失败原因。	TargetIsBusy.DBFS
SnapshotInfo	object	快照相关信息。
SnapshotCount	integer	快照数量。	1
LinkId	string	快照链 id，若没有快照链则为“-”。	sl-9zskwvgoqqqvzxa*******
TotalSize	long	快照容量。	50331648
PolicyId	string	自动快照策略 id，若没有设置自动快照策略则为“-”。	sp-ehuhzlfetb2jiwz*******
AdvancedFeatures	string	数据库文件存储实例使用的 CPU 核数、内存上限值等。 cpuCoreCount：CPU 核数。 memorySize：内存大小，单位 MB。 pageCacheSize：PageCache 缓存大小，单位 MB。	{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}
SnapshotId	string	创建 DBFS 实例使用的快照 ID。	s-uvwtoxcjj6xtlua*******

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "DBFSInfo": {
    "Status": "attached",
    "PayType": "postpaid",
    "FsId": "dbfs-GOrr********Yd0VLOyBpg",
    "Tags": [
      {
        "TagValue": "TestTagValue1",
        "Id": 1,
        "TagKey": "TestTagKey1"
      }
    ],
    "SizeG": 20,
    "EcsList": [
      {
        "EcsId": "i-y2vZ3********vvMilZ2hQ"
      }
    ],
    "RegionId": "cn-hangzhou",
    "DBFSClusterId": "c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD",
    "Description": "desc",
    "ZoneId": "cn-hangzhou-i",
    "FsName": "dbfs-test-01",
    "Category": "standard",
    "CreatedTime": "1609330367000",
    "AttachNodeNumber": 1,
    "KMSKeyId": "c39EcDBf-2Ecb-C3C6-6526-018d4D******",
    "Encryption": false,
    "PerformanceLevel": "PL1",
    "UsedScene": "MySQL 5.7",
    "LastMountTime": "1644915400000",
    "LastUmountTime": "1644915319000",
    "EnableRaid": false,
    "InstanceType": "dbfs.small",
    "RaidStrip": 2,
    "EbsList": [
      {
        "EbsId": "d-bp1hq4******qi7gy1th",
        "SizeG": 20
      }
    ],
    "LastFailed": "TargetIsBusy.DBFS",
    "SnapshotInfo": {
      "SnapshotCount": 1,
      "LinkId": "sl-9zskwvgoqqqvzxa*******",
      "TotalSize": 50331648,
      "PolicyId": "sp-ehuhzlfetb2jiwz*******"
    },
    "AdvancedFeatures": "{\"cpuCoreCount\":0.5,\"memorySize\":512,\"pageCacheSize\":128}",
    "SnapshotId": "s-uvwtoxcjj6xtlua*******"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidRegion.DBFS	The region is not supported.	不支持的区域。
404	EntityNotExist.DBFS	The DBFS instance does not exist.(EntityNotExist.DBFS)	数据库文件存储实例不存在。