1. API Description
Domain name for API request: cfs.intl.tencentcloudapi.com.
File system directory operation API. Currently, only the Turbo series file system supports calling this API to perform directory operations. The Universal Series file system (including the enhanced version) does not support calling.
A maximum of 20 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DoDirectoryOperation. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| FileSystemId | Yes | String | File system ID. currently, only Turbo series file systems support calling this api. general series file systems (including enhanced) do not support calling. |
| OpetationType | Yes | String | create a directory, equivalent to mkdir. check: confirm the existence of the directory, equivalent to stat. move: rename a file or directory, equivalent to mv. |
| DirectoryPath | Yes | String | Absolute path of the directory. recursive creation is enabled by default (if the directory contains non-existent subdirectories, create the corresponding subdirectory first). |
| Mode | No | String | Permission to create directory. if not specified, it defaults to 0755. if OperationType is check, this value is meaningless. |
| DestPath | No | String | The destination directory name for the mv operation. the path must start with /cfs/. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Result | Integer | 1: success 0: failure. for the create directory operation, 1 indicates successful creation, 0 indicates creation failed. for the confirm directory existence operation, 1 indicates the directory exists, 0 indicates the directory does not exist. in addition, if the directory already exists during the create directory operation, it will also return creation succeeded. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 File System Directory Operation API
Perform operations on some types of file system directories
Input Example
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetUserQuota
<Common request parameters>
{
"FileSystemId": "cfs-12345",
"OpetationType": "create",
"DirectoryPath": "/user1/dir1/",
"Mode": "0644"
}
Output Example
{
"Response": {
"RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
"Result": 1
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Feedback