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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDbfs

系统规定参数。取值:ListDbfs。

RegionId String cn-hangzhou

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

PageNumber Integer 1

当前页码。

默认值:1。

PageSize Integer 10

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

最大值:100。

默认值:10。

SortKey String SizeG

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

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

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

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

SortType String desc

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

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

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

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

FilterKey String FsName

查询资源时的筛选键。

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

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

FilterValue String dbfs-test-01

查询资源时的筛选值。

与FilterKey配合使用。

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

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

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

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

返回数据

名称 类型 示例值 描述
TotalCount Integer 32

查询结果总条数。

PageSize Integer 10

输入时设置的每页条数。

PageNumber Integer 1

当前页码。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

DBFSInfo Array of Info

数据库文件系统集合。

AttachNodeNumber Integer 1

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

Category String standard

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

  • standard:标准版
  • enterprise:企业版(公测中)
CreatedTime String 1609330367000

创建时间。

DBFSClusterId String c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD

数据库文件系统集群ID。

EcsList Array of EcsList

挂载到的ECS实例集合。

EcsId String i-y2vZ3********vvMilZ2hQ

已挂载的ECS实例ID。

Encryption Boolean false

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

FsId String dbfs-GOrr********Yd0VLOyBpg

数据库文件系统ID。

FsName String dbfs-test-01

数据库文件系统名称。

KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb408***

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

PayType String postpaid

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

RegionId String cn-hangzhou

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

SizeG Integer 20

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

Status String attached

数据库文件系统的状态。

取值范围:

  • unattached 待挂载
  • attached 已挂载
  • creating 创建中
  • attaching 挂载中
  • detaching 卸载中
  • deleting 删除中
  • deleted 已删除
  • resizing 扩容中
  • snapshotting 快照中
  • upgrading 升级中
Tags Array of TagList

标签集合。

Id Long 1

标签ID。

TagKey String TestTagKey1

标签键。

TagValue String TestTagValue1

标签值。

ZoneId String cn-hangzhou-i

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListDbfs
&RegionId=cn-hangzhou
&PageNumber=1
&<公共请求参数>

正常返回示例

XML 格式

<ListDbfsResponse>
      <TotalCount>32</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <PageNumber>1</PageNumber>
      <DBFSInfo>
            <Status>attached</Status>
            <Encryption>true</Encryption>
            <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb408***</KMSKeyId>
            <CreatedTime>1609330367000</CreatedTime>
            <Category>standard</Category>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <SizeG>20</SizeG>
            <FsId>dbfs-GOrr********Yd0VLOyBpg</FsId>
            <DBFSClusterId>c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD</DBFSClusterId>
            <PayType>postpaid</PayType>
            <FsName>dbfs-test-01</FsName>
            <AttachNodeNumber>1</AttachNodeNumber>
            <RegionId>cn-hangzhou</RegionId>
            <EcsList>
                  <EcsId>i-y2vZ3********vvMilZ2hQ</EcsId>
            </EcsList>
            <Tags>
                  <TagKey>TestTagKey1</TagKey>
                  <Id>1</Id>
                  <TagValue>TestTagValue1</TagValue>
            </Tags>
            <Tags>
                  <TagKey>TestTagKey2</TagKey>
                  <Id>2</Id>
                  <TagValue>TestTagValue2</TagValue>
            </Tags>
      </DBFSInfo>
</ListDbfsResponse>

JSON 格式

{
    "TotalCount": 32,
    "PageSize": 10,
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "PageNumber": 1,
    "DBFSInfo": {
        "Status": "attached",
        "Encryption": true,
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb408***",
        "CreatedTime": 1609330367000,
        "Category": "standard",
        "ZoneId": "cn-hangzhou-i",
        "SizeG": 20,
        "FsId": "dbfs-GOrr********Yd0VLOyBpg",
        "DBFSClusterId": "c39EcDBf-2Ecb-C3C6-6526-018d4Dcf63eD",
        "PayType": "postpaid",
        "FsName": "dbfs-test-01",
        "AttachNodeNumber": 1,
        "RegionId": "cn-hangzhou",
        "EcsList": [
            {
                "EcsId": "i-y2vZ3********vvMilZ2hQ"
            }
        ],
        "Tags": [
            {
                "TagKey": "TestTagKey1",
                "Id": 1,
                "TagValue": "TestTagValue1"
            },
            {
                "TagKey": "TestTagKey2",
                "Id": 2,
                "TagValue": "TestTagValue2"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegion.DBFS The region is not supported. 不支持的区域。

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

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