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

调用 CreateNs 接口,为数据湖场景实例创建一个 Namespace,即挂载 TOS 对象存储。

注意事项

  • 仅数据湖实例支持该接口。
  • 每个数据湖实例最多挂载 50 个 TOS Bucket。如果需要挂载更多 Bucket,请提交工单申请提升上限。

请求参数

参数

类型

是否必填

示例值

说明

FsName

String

doc-test-cfs-1

需要创建 Namespace 的数据湖场景实例的名称。

TosBucket

String

bucket-name

需要挂载的 TOS 对象存储桶。
您可以直接设置 Bucket 名称,以使用当前账号或其他账号的目标存储桶。

TosPrefix

String

prefix/

支持将 TOS 的子路径挂载到文件存储实例。

  • 非必填项,可为空,为空时表示根路径。
  • 填写时不得以左斜线(/)开头,需要以左斜线(/)结尾,如 prefix/
    示例: TOS 路径为 tos://tos-doctest/prefix,配置的文件存储前缀可以为 prefix/。此时访问 CFS 实例的根目录就等同于访问 TOS 的prefix/;访问 CFS 实例的 /test,就等于 TOS 的 prefix/test

TosAccountId

Integer

2100***0000

当选择关联其他账号下的存储桶时,需要设置该账号的 ID。

TosAk

String

AKxxxx

当选择关联其他账号下的存储桶时,需要设置该账号的 Access Key ID。

TosSk

String

SKxxxx

当选择关联其他账号下的存储桶时,需要设置该账号的 Secret Access Key。

ReadOnly

Boolean

false

挂载 TOS Bucket 时自动创建的 Namespace,是否为只读。

  • true:是
  • false:否,默认值

    说明

    判断挂载 TOS Bucket 时自动创建的 Namespace是否为只读的判断逻辑说明如下:

    1. 如果请求中填了 ReadOnly 参数,则使用当前配置值来判断是否只读。
    2. 如果请求中没有填 ReadOnly 参数,但是填了 TosAk 和 TosSk,则会根据 TosAk 和 TosSk 的读写权限情况来判断是否只读。
    3. 如果上述两种情况相关参数都没填,则表示使用默认值 false。

返回参数

参数

类型

示例值

说明

TaskId

String

87a37526**6996857ee5f7

后台任务 ID,前端无需处理

请求示例

POST https://open.volcengineapi.com?Action=CreateNs&Version=2022-02-02
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs
{
"FsName": "doc-test-cfs-1",
"TosBucket": "bucket-name",
"TosPrefix": "prefix/"
}

返回示例

{
    "Result": {
        "TaskId": "87a37526**6996857ee5f7"
    },
    "ResponseMetadata": {
        "RequestId": "202304231843**D75F67086427",
        "Action": "CreateNs",
        "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 不存在或不属于该用户。

400

EmptyTosBucket

TosBucket 为空。

404

TosBucketNotFound

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

400

InvalidTosPrefix

TosPrefix 不合法。

404

TosAccountIdNotFound

TosAccountId 不存在。

400

InvalidTosCredentials

TosCredentials 不合法。