调用ListDbfs查询您已经创建的数据库文件系统列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dbfs:ListDbfs | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | DBFS 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
PageNumber | integer | 是 | 当前页码。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页条数。 最大值:100。 默认值:10。 | 10 |
SortKey | string | 否 | 查询资源时设置排序方式。 与 SortType 配合使用,取值必须为 SizeG 或 CreatedTime。 取值为 SizeG 则根据容量排序,取值为 CreatedTime 则根据创建时间排序。 默认根据创建时间倒序排列。 | SizeG |
SortType | string | 否 | 查询资源时设置排序方式。 与 SortKey 配合使用,取值必须为 asc 或 desc。 取值为 asc 则正序排列,取值为 desc 则正序排列。 默认根据创建时间倒序排列。 | desc |
FilterKey | string | 否 | 查询资源时的筛选键。 与 FilterValue 配合使用,取值必须为 FsId 或 FsName。 传入 FsId 则根据数据库文件系统的实例 ID 进行筛选,传入 FsName 则根据数据库文件系统的实例名称进行筛选。 | FsName |
FilterValue | string | 否 | 查询资源时的筛选值。 与 FilterKey 配合使用。 | dbfs-test-01 |
Tags | string | 否 | 根据标签筛选数据库文件系统列表。 TagKey:资源的标签键。取值范围:最大长度为 64 个字符,可包含英文大小写字母、中文、数字和特殊符号@_-=+;:,<.>/? TagValue:资源的标签值。取值范围:最大长度为 128 个字符,可包含英文大小写字母、中文、数字和特殊符号@_-=+;:,<.>/? | [{"TagKey":"k1","TagValue":"v1"},{"TagKey":"k2","TagValue":"v2"}] |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidRegion.DBFS | The region is not supported. | 不支持的区域。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2024-02-27 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
2022-01-19 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|