文档

ListDbfs - 查询数据库文件系统列表

更新时间:

调用ListDbfs查询您已经创建的数据库文件系统列表。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
PageNumberinteger

当前页码。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页条数。

最大值:100。

默认值:10。

10
SortKeystring

查询资源时设置排序方式。

与 SortType 配合使用,取值必须为 SizeG 或 CreatedTime。

取值为 SizeG 则根据容量排序,取值为 CreatedTime 则根据创建时间排序。

默认根据创建时间倒序排列。

SizeG
SortTypestring

查询资源时设置排序方式。

与 SortKey 配合使用,取值必须为 asc 或 desc。

取值为 asc 则正序排列,取值为 desc 则正序排列。

默认根据创建时间倒序排列。

desc
FilterKeystring

查询资源时的筛选键。

与 FilterValue 配合使用,取值必须为 FsId 或 FsName。

传入 FsId 则根据数据库文件系统的实例 ID 进行筛选,传入 FsName 则根据数据库文件系统的实例名称进行筛选。

FsName
FilterValuestring

查询资源时的筛选值。

与 FilterKey 配合使用。

dbfs-test-01
Tagsstring

根据标签筛选数据库文件系统列表。

TagKey:资源的标签键。取值范围:最大长度为 64 个字符,可包含英文大小写字母、中文、数字和特殊符号@_-=+;:,<.>/?

TagValue:资源的标签值。取值范围:最大长度为 128 个字符,可包含英文大小写字母、中文、数字和特殊符号@_-=+;:,<.>/?

[{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}]

返回参数

名称类型描述示例值
object
TotalCountinteger

查询结果总条数。

32
PageSizeinteger

输入时设置的每页条数。

10
RequestIdstring

请求 ID。

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

当前页码。

1
DBFSInfoobject []

数据库文件系统集合。

Statusstring

数据库文件系统的状态。

取值范围:

  • unattached 待挂载

  • attached 已挂载

  • creating 创建中

  • attaching 挂载中

  • detaching 卸载中

  • deleting 删除中

  • deleted 已删除

  • resizing 扩容中

  • snapshotting 快照中

  • upgrading 升级中

attached
Encryptionboolean

是否为加密的数据库文件系统。

false
PayTypestring

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

postpaid
FsIdstring

数据库文件系统 ID。

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

标签集合。

TagValuestring

标签值。

TestTagValue1
Idlong

标签 ID。

1
TagKeystring

标签键。

TestTagKey1
SizeGinteger

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

20
EcsListobject []

挂载到的 ECS 实例集合。

EcsIdstring

已挂载的 ECS 实例 ID。

i-y2vZ3********vvMilZ2hQ
EbsListobject []

云盘列表。

EbsIdstring

DBFS 使用的云盘 ID。

d-bp1383******3uir001r
SizeGinteger

云盘容量。单位 GiB。

20
RegionIdstring

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

cn-hangzhou
DBFSClusterIdstring

数据库文件系统集群 ID。

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

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

cn-hangzhou-i
FsNamestring

数据库文件系统名称。

dbfs-test-01
Categorystring

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

  • standard:标准版

  • enterprise:企业版(公测中)

standard
CreatedTimestring

创建时间。

1609330367000
AttachNodeNumberinteger

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

1
KMSKeyIdstring

数据库文件系统使用的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb408***
PerformanceLevelstring

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

  • PL0

  • PL1

  • PL2

  • PL3

PL1
UsedScenestring

使用场景。

MySQL 5.7
LastMountTimestring

最后挂载时间。

1644915400000
LastUmountTimestring

最后卸载时间。

1644915319000
EnableRaidboolean

是否使能 RAID。

false
RaidStripinteger

条带数量。

2
InstanceTypestring

DBFS 实例规格。取值范围:

  • dbfs.small

  • dbfs.medium

  • dbfs.large

dbfs.small
LastFailedstring

最近一次操作失败的原因。

TargetIsBusy.DBFS
SnapshotInfoobject

相关快照信息。

SnapshotCountinteger

快照总个数。

1
TotalSizelong

快照链中所有快照的大小,单位为 Byte。

50331648
LinkIdstring

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

sl-b3zlgraysgcs9jy*******
PolicyIdstring

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

sp-ehuhzlfetb2jiwz*******

示例

正常返回示例

JSON格式

{
  "TotalCount": 32,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "DBFSInfo": [
    {
      "Status": "attached",
      "Encryption": false,
      "PayType": "postpaid",
      "FsId": "dbfs-GOrr********Yd0VLOyBpg",
      "Tags": [
        {
          "TagValue": "TestTagValue1",
          "Id": 1,
          "TagKey": "TestTagKey1"
        }
      ],
      "SizeG": 20,
      "EcsList": [
        {
          "EcsId": "i-y2vZ3********vvMilZ2hQ"
        }
      ],
      "EbsList": [
        {
          "EbsId": "d-bp1383******3uir001r",
          "SizeG": 20
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBFSClusterId": "c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD",
      "ZoneId": "cn-hangzhou-i",
      "FsName": "dbfs-test-01",
      "Category": "standard",
      "CreatedTime": "1609330367000",
      "AttachNodeNumber": 1,
      "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb408***",
      "PerformanceLevel": "PL1",
      "UsedScene": "MySQL 5.7",
      "LastMountTime": "1644915400000",
      "LastUmountTime": "1644915319000",
      "EnableRaid": false,
      "RaidStrip": 2,
      "InstanceType": "dbfs.small",
      "LastFailed": "TargetIsBusy.DBFS",
      "SnapshotInfo": {
        "SnapshotCount": 1,
        "TotalSize": 50331648,
        "LinkId": "sl-b3zlgraysgcs9jy*******",
        "PolicyId": "sp-ehuhzlfetb2jiwz*******"
      }
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegion.DBFSThe region is not supported.不支持的区域。

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

变更历史

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