You need to enable JavaScript to run this app.
导航
ListNs
最近更新时间:2023.05.18 15:33:39首次发布时间:2023.05.18 14:53:13

调用 ListNs 接口,查询数据湖场景实例中的 Namespace 列表,也会返回挂载的 TOS Bucket。

注意事项

仅数据湖场景实例支持该接口。

请求参数

Query

参数

类型

是否必填

示例值

说明

FsName

String

doc-test-cfs-1

目标数据湖场景实例的名称。

NsId

Long

1801439***487040

单个查询 Namespace 时,设置目标 Namespace 的 ID。

TosBucket

String

bucket-name

根据挂载的对象存储 Bucket 的名称查询。

PageNumber

Integer

0

页数,从 0 开始。

PageSize

Integer

10

每页能展示的 Namespace 的数量。

NsIdOrder

String

DESC

根据 NsId 进行排序。

  • DESC:降序排列
  • ASC:升序排列

CreateTimeOrder

String

DESC

根据 Namespace 的创建时间进行排序。

  • DESC:降序排列
  • ASC:升序排列

返回参数

参数

类型

示例值

说明

Items

List

[ns1, ns2]

Namespace 列表。详情请参见 Namespace 数据结构

TotalSize

String

2

满足查询条件的 Namespace 总数。

PageNumber

Integer

0

当前页数。

PageSize

Integer

10

每页能展示的 Namespace 数量。

Namespace 数据结构

参数

类型

示例值

说明

Id

String

1801439***487040

Namespace 的 ID。

TosBucket

String

bucket-xxx

挂载的 TOS Bucket。

TosPrefix

String

prefix/

挂载前缀。

ReadOnly

Boolean

true

是否为只读 Namespace。

  • true:是
  • false:否

IsMyBucket

Boolean

true

是否是您自己的 Bucket。

  • true:是
  • false:否

ServiceManaged

Boolean

false

是否为火山引擎官方服务 Namespace。

  • true:是
  • false:否

CreatedTime

String

2022-01-19 11:07:20

Namespace 的创建时间。

Status

String

UP

Namespace 的状态。

  • INIT 挂载中
  • CREATING:挂载中
  • UP:运行中
  • TO_DELETE:删除中
  • DELETING:删除中
  • CREATE_FAILED:挂载失败
  • DELETE_FAILED:删除失败
  • ERROR:异常
  • DOWN:异常

请求示例

GET https://open.volcengineapi.com?Action=ListNs&Version=2022-02-02&FsName=doc-test-cfs-2&CreateTimeOrder=DESC
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs

返回示例

{
    "Result": {
        "Items": [
            {
                "Id": "1801439***487040",
                "TosBucket": "bucket-name",
                "TosPrefix": "prefix/",
                "ReadOnly": true,
                "IsMyBucket": true,
                "ServiceManaged": false,
                "CreatedTime": "2023-04-23T18:45:00",
                "Status": "CREATING"
            },
            {
                "Id": "18014***487028",
                "TosBucket": "bucket-name",
                "TosPrefix": "prefix/",
                "ReadOnly": false,
                "IsMyBucket": true,
                "ServiceManaged": false,
                "CreatedTime": "2023-04-23T17:46:16",
                "Status": "UP"
            }
        ],
        "TotalSize": "2",
        "PageNumber": 0,
        "PageSize": 10
    },
    "ResponseMetadata": {
        "RequestId": "2023042318453214***C31DD60A459E",
        "Action": "ListNs",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

错误码

下表列举了本接口的错误码信息。公共错误码信息,请参考公共错误码

HttpCode

错误码

错误信息

400

EmptyFsName

FsName 为空。

400

InvalidFsName

输入 FsName 时,文件存储实例名称不合法。

  • 文件存储实例名称仅支持字母、数字、英文,且以字母开头。
  • 文件存储实例名称字符长度在 2-63 内。

400

InvalidMode

FileSystem 场景不合法。

404

FsNameNotFound

FsName 不存在或不属于该用户。