调用GetDbfs查询数据库文件系统详情。

调试

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

请求参数

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

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

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

数据库文件系统ID。

RegionId String cn-hangzhou

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

返回数据

名称 类型 示例值 描述
DBFSInfo Struct

数据库文件系统实例。

AttachNodeNumber Integer 1

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

Category String standard

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

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

创建时间。

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

数据库文件系统集群ID。

Description String desc

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

EcsList Array of EcsList

挂载到的ECS实例集合。

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

已挂载的ECS实例ID。

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

数据库文件系统ID。

FsName String dbfs-test-01

数据库文件系统名称。

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 Integer 1

标签ID。

TagKey String TestTagKey1

标签键。

TagValue String TestTagValue1

标签值。

ZoneId String cn-hangzhou-i

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

Encryption Boolean false

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

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

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

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDbfs
&FsId=dbfs-GOrr********Yd0VLOyBpg
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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

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

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