文档

GetDbfs - 查询单个数据库文件系统

更新时间:

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbfs:GetDbfsRead
  • DbfsInstance
    acs:dbfs:{#regionId}:{#accountId}:dbfsinstance/*

请求参数

名称类型必填描述示例值
RegionIdstring

DBFS实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

cn-hangzhou
FsIdstring

数据库文件系统ID。

dbfs-GOrr********Yd0VLOyBpg

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
DBFSInfoobject

数据库文件系统实例。

Statusstring

数据库文件系统的状态。

取值范围:

  • unattached 待挂载

  • attached 已挂载

  • creating 创建中

  • attaching 挂载中

  • detaching 卸载中

  • deleting 删除中

  • deleted 已删除

  • resizing 扩容中

  • snapshotting 快照中

  • upgrading 升级中

attached
PayTypestring

数据库文件系统的付费类型,目前仅支持按量付费(postpaid)。

postpaid
FsIdstring

数据库文件系统ID。

dbfs-GOrr********Yd0VLOyBpg
Tagsobject []

标签集合。

TagValuestring

标签值。

TestTagValue1
Idinteger

标签ID。

1
TagKeystring

标签键。

TestTagKey1
SizeGinteger

数据库文件系统大小,单位GiB。

20
EcsListobject []

挂载到的ECS实例集合。

EcsIdstring

已挂载的ECS实例ID。

i-y2vZ3********vvMilZ2hQ
RegionIdstring

数据库文件系统所属的地域ID。

cn-hangzhou
DBFSClusterIdstring

数据库文件系统集群ID。

c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD
Descriptionstring

数据库文件系统描述信息。

desc
ZoneIdstring

数据库文件系统所属的可用区ID。

cn-hangzhou-i
FsNamestring

数据库文件系统名称。

dbfs-test-01
Categorystring

数据库文件系统类型。取值范围:

  • standard:标准版

  • enterprise:企业版(公测中)

standard
CreatedTimestring

创建时间。

1609330367000
AttachNodeNumberinteger

数据库文件系统挂载的节点数。

1
KMSKeyIdstring

KMS密钥ID。

c39EcDBf-2Ecb-C3C6-6526-018d4D******
Encryptionboolean

是否已加密。

false
PerformanceLevelstring

云盘性能等级。取值范围:

  • PL0

  • PL1

  • PL2

  • PL3

PL1
UsedScenestring

使用场景。

MySQL 5.7
LastMountTimestring

最后挂载时间。

1644915400000
LastUmountTimestring

最后卸载时间。

1644915319000
EnableRaidboolean

是否使能RAID。

false
InstanceTypestring

DBFS实例规格。取值范围:

  • dbfs.small

  • dbfs.medium

  • dbfs.large

dbfs.small
RaidStripinteger

条数个数。

2
EbsListobject []

DBFS使用的云盘列表。

EbsIdstring

云盘ID。

d-bp1hq4******qi7gy1th
SizeGinteger

云盘容量。单位GiB。

20
LastFailedstring

最近一次操作失败原因。

TargetIsBusy.DBFS
SnapshotInfoobject

快照相关信息。

SnapshotCountinteger

快照数量。

1
LinkIdstring

快照链id,若没有快照链则为“-”。

sl-9zskwvgoqqqvzxa*******
TotalSizelong

快照容量。

50331648
PolicyIdstring

自动快照策略id,若没有设置自动快照策略则为“-”。

sp-ehuhzlfetb2jiwz*******
AdvancedFeaturesstring

数据库文件存储实例使用的CPU核数、内存上限值等。

  • cpuCoreCount:CPU核数。
  • memorySize:内存大小,单位MB。
  • pageCacheSize:PageCache缓存大小,单位MB。
{"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128}
SnapshotIdstring

创建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错误码错误信息描述
400InvalidRegion.DBFSThe region is not supported.不支持的区域。
404EntityNotExist.DBFSThe DBFS instance does not exist.(EntityNotExist.DBFS)数据库文件存储实例不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-01-04OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2022-01-19OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈