Big Data File Storage
Big Data File Storage
Document
- Documentation
Big Data File StorageAPI referenceV2（2024-08-01）Manage namespacesCreateNamespace - Create namespace
Copy page
Download PDFManage namespaces
CreateNamespace - Create namespace
Copy pageDownload PDFCreateNamespace - Create namespace
Call the CreateNamespace API to create a namespace.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the request parameters specific to this API and some common parameters are listed below. For more information, seeCommon parametersforward slashs (/).
Query
Action string required Example value: CreateNamespace
The action to perform. Value: CreateNamespace.
Version string required Example value: 2024-08-01
API version. Value: 2024-08-01.
Body
FileSystemId string No Example value: 123456
File System ID.
FileSystemName string No Example value: test
The name of the file system.
NamespaceType string required Example value: ACC_TOS
Namespace type.
MountPath string No Example value: /test
Mount path.
TosBucket string No Example value: test
TOS bucket to mount.
TosRegion string No Example value: cn-beijing
Region where the TOS bucket is mounted.
TosPrefix string No Example value: test/
TOS mount prefix.
TosCredentialType string No Example value: ServiceRole
TOS credential type.
TosStaticCredential object No Example value: For details, see the request example
TOS static credentials.
AccessKeyId string required Example value: AKxxxx
User identifier, abbreviated as AK.
SecretAccessKey string required Example value: SKxxxx
User identification key, abbreviated as SK.
TosRoleCredential object[] No Example value: For details, see the request example
TOS role credentials.
AccountId string required Example value: 210000****
Account ID.
Role string required Example value: RoleForTest
Role name.
Description string No Example value: test
Description.
Response parameters
Only the response parameters specific to this API are listed below. For more information, seeResponse structureforward slashs (/).
TaskId string Example value: abcd
Task ID.
NamespaceId string Example value: 123456
Namespace ID.
Request example
POST /?Action=CreateNamespace&Version=2024-08-01&Description=%E6%B5%8B%E8%AF%95 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250107T094431Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250107/cn-beijing/cfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"FileSystemId": "123456",
"FileSystemName": "test",
"NamespaceType": "ACC_TOS",
"MountPath": "/test",
"TosBucket": "test",
"TosRegion": "cn-beijing",
"TosPrefix": "test/",
"TosCredentialType": "ServiceRole",
"TosStaticCredential": {
"AccessKeyId": "AKxxxx",
"SecretAccessKey": "SKxxxx"
},
"TosRoleCredential": [
{
"AccountId": "2100000000",
"Role": "RoleForTest"
}
]
}
Response example
{
"ResponseMetadata": {
"RequestId": "20241223120131015007156168D0295E",
"Action": "CreateNamespace",
"Version": "2024-08-01",
"Service": "cfs",
"Region": "cn-beijing"
},
"Result": {
"TaskId": "abcd",
"NamespaceId": "123456"
}
}
Error codes
The following table lists the error codes related to the business logic of this API. For common error codes, seeCommon error codesdocumentation.
Last updated: 2026.02.02 11:27:57
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
