# Alibaba Cloud Database File System API

> Alibaba Cloud Database File System API on Apizie: 36 endpoints (Call AddTagsBatch to add tags to multiple Database File System (DBFS) instances in a single batch operation.…, Applies an automatic snapshot policy to one or more database file systems (DBFS), Call the AttachDbfs operation to attach a pay-as-you-go database file system to an ECS instance. The ECS…, Cancels the automatic snapshot policy for one or more database file systems, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dbfs`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dbfs
- Page: https://zieapi.vercel.app/api/cloud/aliyun-dbfs
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-dbfs/openapi.json

Alibaba Cloud OpenAPI for Database File System (dbfs, version 2020-04-18). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Call AddTagsBatch to add tags to multiple Database File System (DBFS) instances in a single batch operation.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/add-tags-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions |
| DbfsList | string | yes | A list of DBFS instances to which you want to add tags |
| Tags | string | yes | A list of tags to add. TagKey: The tag key for the resource. Maximum length is 64 characters. Valid characters include uppercase and… |
| ClientToken | string | no | Ensures request idempotence. Generate a unique value from your client for this parameter to differentiate between requests. ClientToken… |

### Applies an automatic snapshot policy to one or more database file systems (DBFS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/apply-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| PolicyId | string | yes | The ID of the automatic snapshot policy |
| DbfsIds | string | yes | A JSON array of DBFS IDs to which you want to apply the automatic snapshot policy. Separate IDs with commas. For example:… |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions |

### Call the AttachDbfs operation to attach a pay-as-you-go database file system to an ECS instance. The ECS…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/attach-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| ECSInstanceId | string | yes | The ID of the destination ECS instance |
| ServerUrl | string | no | The address of the DBFS package. This parameter is deprecated |
| FsId | string | yes | The ID of the database file system to attach. The database file system (FsId) and the ECS instance (ECSInstanceId) must be in the same zone |
| RegionId | string | yes | The ID of the region. You can call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to view the latest… |
| AttachMode | string | no | The attach mode. Valid values: ``` create_new_mount_point - Create a new mount target (default) use_exist_mount_point - Use an existing… |
| AttachPoint | string | no | The path of the mount target. If you do not specify this parameter, a path is randomly generated |

### Cancels the automatic snapshot policy for one or more database file systems
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/cancel-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| PolicyId | string | yes | The ID of the automatic snapshot policy |
| DbfsIds | string | yes | The IDs of the database file systems for which to cancel the automatic snapshot policy. The value must be a JSON array. For example:… |
| RegionId | string | yes | The ID of the region. You can call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to query the most… |

### Create an automatic snapshot policy in a specified region. An automatic snapshot policy periodically creates…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/create-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| PolicyName | string | yes | The policy name |
| RetentionDays | integer | yes | The retention period in days |
| RepeatWeekdays | string | yes | A list of repeat dates for automatic snapshots. The unit is day, and the cycle is week. Value range: 1 to 7. For example, 1 indicates… |
| TimePoints | string | yes | A list of creation time points for automatic snapshots. Use UTC+8 time. The unit is hour. Value range: 0 to 23, representing 24 time… |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud region list |

### Call CreateDbfs to create a pay-as-you-go Database File System (DBFS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/create-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. To view the latest list of Alibaba Cloud regions, call DescribeRegions… |
| FsName | string | yes | The name of the database file system. Valid values: 2 to 128 characters. The name must start with an English letter (case-sensitive) or a… |
| Category | string | yes | The DBFS edition. Valid values: standard: Standard Edition enterprise: Enterprise Edition |
| SizeG | integer | yes | The capacity in GiB. If you specify this parameter, its value must be greater than or equal to the capacity of the specified snapshot.… |
| ZoneId | string | yes | The zone ID of the DBFS instance |
| ClientToken | string | no | A client token used to ensure idempotence. Generate a unique value on your client for each request. ClientToken supports only ASCII… |
| SnapshotId | string | no | The snapshot ID used to create the DBFS instance |
| DeleteSnapshot | string | no | Specifies whether to delete the source snapshot after creating the DBFS instance from it |
| PerformanceLevel | string | no | The performance level of the DBFS instance. Valid values: PL0: Up to 10,000 random read/write IOPS per disk PL1: Up to 50,000 random… |
| EnableRaid | string | no | Specifies whether to create the DBFS instance using RAID. Valid values: true or false. Default value: false |
| RaidStripeUnitNumber | integer | no | The number of stripes. Required when EnableRaid is set to true. Valid values: 2 to 8 |
| KMSKeyId | string | no | The KMS key ID used by the DBFS instance |
| Encryption | string | no | Specifies whether to encrypt the DBFS instance. Valid values: true or false. Default value: false |
| UsedScene | string | no | The use case for the DBFS instance. Valid values: MySQL 5.7 PostgreSQL MongoDB Oracle RAC |
| InstanceType | string | no | The instance type. Valid values: dbfs.small dbfs.medium dbfs.large (default) |
| AdvancedFeatures | string | no | Customize CPU cores, memory limit, and PageCache size for the DBFS instance. cpuCoreCount: Number of CPU cores. memorySize: Memory size in… |

### Call CreateServiceLinkedRole to create a service-linked role that DBFS uses to manage dependent cloud…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/create-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions |
| ClientToken | string | no | Ensures request idempotence. Generate a unique value from your client for this parameter across different requests. ClientToken supports… |
| AutoCreateServiceLinkedRole | string | no | The AutoCreateServiceLinkedRole |

### Call CreateSnapshot to create a snapshot for a database file system
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/create-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the DBFS instance resides. You can call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to… |
| FsId | string | yes | The ID of the database file system |
| SnapshotName | string | no | The display name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character. It… |
| Description | string | no | The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |
| RetentionDays | integer | no | The retention period of the snapshot, in days. The snapshot is automatically released after the retention period expires. Valid values: 1… |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a unique token on the client. The token can contain only ASCII… |

### Deletes an automatic snapshot policy. File systems that use this policy automatically stop applying it after…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/delete-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| PolicyId | string | yes | Automatic snapshot policy ID |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba Cloud region list |

### The DeleteDbfs operation releases a pay-as-you-go database file system
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/delete-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the DBFS is located. To query the latest list of regions, see DescribeRegions… |
| FsId | string | yes | The ID of the DBFS |
| Force | string | no | Specifies whether to forcibly delete the DBFS. The default value is false |

### Call DeleteSnapshot to delete one or more DBFS snapshots
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/delete-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of… |
| SnapshotId | string | yes | The ID of the snapshot or a list of snapshot IDs. To delete a single snapshot, enter the snapshot ID. For batch deletion, enter the… |
| Force | string | no | Specifies whether to force delete the snapshot. Default value: false |

### Call DeleteTagsBatch to remove tags from multiple Database File System (DBFS) instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/delete-tags-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions |
| DbfsList | string | yes | The list of DBFS instances from which to remove tags |
| Tags | string | yes | The list of tags to remove. TagKey: The tag key. The tag key can be up to 64 characters in length and can contain letters, digits, Chinese… |

### Call DescribeDbfsSpecifications to query DBFS specifications
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/describe-dbfs-specifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |
| EcsInstanceType | string | yes | The ECS instance type family |
| Category | string | yes | The DBFS edition. Valid values: standard enterprise |

### Queries the instance types supported by DBFS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/describe-instance-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud… |

### Call DetachDbfs to detach a pay-as-you-go DBFS from an ECS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/detach-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| FsId | string | yes | The ID of the database file system |
| ECSInstanceId | string | yes | The ID of the ECS instance from which to detach the file system |
| RegionId | string | yes | The ID of the region where the DBFS instance resides. You can call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to… |

### Queries the details of a single automatic snapshot policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/get-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| PolicyId | string | yes | The ID of the automatic snapshot policy |
| RegionId | string | yes | The ID of the region. You can call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to query the most… |

### Call GetDbfs to retrieve details about a Database File System (DBFS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/get-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. Invoke DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba… |
| FsId | string | yes | The Database File System ID |

### You can call GetServiceLinkedRole to check whether a service-linked role has been created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/get-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions |

### Retrieves the snapshot chain for a Database File System (DBFS). A snapshot chain is a sequence that includes…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/get-snapshot-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to query the most recent list of… |
| LinkId | string | no | The snapshot chain ID |

### Queries all auto snapshot policies that meet the specified query conditions in a region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-auto-snapshot-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to query the most recent… |
| PageNumber | integer | no | The page number for the paging query. Default value: 1 |
| PageSize | integer | no | The number of entries per page for the paging query. Default value: 10 |
| FilterKey | string | no | The filter key used to query resources. This parameter must be used together with FilterValue. Valid values: PolicyId: Filters auto… |
| FilterValue | string | no | The filter value used to query auto snapshot policies. This parameter must be used together with FilterKey |

### Retrieves a list of Database File System (DBFS) instances that have a specific automatic snapshot policy…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-auto-snapshot-policy-applied-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to obtain the latest list of Alibaba Cloud… |
| PolicyId | string | yes | The ID of the automatic snapshot policy |
| PageNumber | integer | no | The page number. The default value is 1 |
| PageSize | integer | no | The number of entries per page. The default value is 10 |
| FilterKey | string | no | The filter key for the query. This parameter is used with \`FilterValue\`. The value must be \`FsId\` or \`FsName\`. \`FsId\` filters the… |
| FilterValue | string | no | The filter value for the query. This parameter is used with \`FilterKey\` |

### Queries all created Database File System (DBFS) instances that meet the query conditions and do not have an…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-auto-snapshot-policy-unapplied-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to query the most recent… |
| PageNumber | integer | no | The page number Settings for paging in a paged query. Default value: 1 |
| PageSize | integer | no | The number of entries per page Settings for paging in a paged query. Default value: 10 |
| FilterKey | string | no | The filter key used to query resources. This parameter must be used together with FilterValue. Valid values: FsId: filters resources by… |
| FilterValue | string | no | The filter value used to query resources. This parameter must be used together with FilterKey |

### Call ListDbfs to query the database file systems you have created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of… |
| PageNumber | integer | no | The current page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page for paged queries. Maximum value: 100. Default value: 10 |
| SortKey | string | no | The field to sort by when querying resources. Use with SortType. Valid values: SizeG or CreatedTime. If you set SortKey to SizeG, results… |
| SortType | string | no | The sort order when querying resources. Use with SortKey. Valid values: asc or desc. If you set SortType to asc, results are sorted in… |
| FilterKey | string | no | The filter key when querying resources. Use with FilterValue. Valid values: FsId or FsName. If you specify FsId, the system filters by… |
| FilterValue | string | no | The filter value when querying resources. Use with FilterKey |
| Tags | string | no | Filter the list of DBFS instances by tags. TagKey: The tag key of the resource. Valid values: Up to 64 characters. Can include uppercase… |

### Call ListDbfsAttachableEcsInstances to query the list of ECS instances that can be attached to a DBFS file…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-dbfs-attachable-ecs-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |
| PageNumber | integer | no | The page number of the current page. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page for a paged query. Default value: 10 |
| FilterKey | string | no | The filter key used when querying resources. Use with FilterValue. Valid values: InstanceId or InstanceName. If you specify InstanceId,… |
| FilterValue | string | no | The filter value used when querying resources. Use with FilterKey |

### You can call the ListDbfsAttachedEcsInstances operation to query the ECS instances on which a DBFS is mounted
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-dbfs-attached-ecs-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |
| FsId | string | yes | The ID of the DBFS instance |

### Queries a list of Database File System (DBFS) snapshots
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. You can call the DescribeRegions (https://help.aliyun.com/document_detail/25609.html) operation to… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 10 |
| SortKey | string | no | The sorting Settings when querying snapshots. This parameter must be used together with SortType. Valid values: SnapshotSize and… |
| SortType | string | no | The sort order used to query snapshots. This parameter must be used together with SortKey. Valid values: asc and desc. A value of asc… |
| FilterKey | string | no | The filter key used to query snapshots. This parameter must be used together with FilterValue. Valid values: SnapshotId and SnapshotName.… |
| FilterValue | string | no | The filter value used to query snapshots. This parameter must be used together with FilterKey |
| FsId | string | no | The ID of the Database File System (DBFS) |
| Status | string | no | The snapshot status. Valid values: progressing: The snapshot is being created. accomplished: The snapshot was created successfully.… |
| SnapshotName | string | no | The snapshot name |
| SnapshotType | string | no | The snapshot creation type. Currently, only manual snapshots are supported. user: Manual snapshot. all: All snapshot creation types. This… |
| SnapshotIds | string | no | The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple IDs with commas (,) |

### Queries snapshot chains that meet specified conditions in a region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-snapshot-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page in the paging Settings for a paged query. Maximum value: 100. Default value: 10 |
| FilterKey | string | no | The filter key used to query snapshot chains. This parameter must be used together with FilterValue. Valid values: LinkId and FsId. If you… |
| FilterValue | string | no | The filter value used to query snapshot chains. This parameter must be used together with FilterKey |
| FsIds | string | no | The ID of the Database File System (DBFS). You can specify up to 100 file system IDs at a time. The value of the FsIds parameter must be a… |
| LinkIds | string | no | The ID of the snapshot chain. You can specify up to 100 snapshot chain IDs at a time. The value of the LinkIds parameter must be a JSON… |

### Call ListTagKeys to query all existing tag keys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-tag-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |

### Call ListTagValues to retrieve all values associated with a specific tag key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/list-tag-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |
| TagKey | string | yes | The tag key of the resource. The value can be up to 64 characters in length and can contain letters, digits, Chinese characters, and… |

### Modifies an automatic snapshot policy. After you modify the policy, all DBFS file systems that use this…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/modify-auto-snapshot-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| PolicyId | string | yes | The ID of the automatic snapshot policy |
| PolicyName | string | no | The name of the automatic snapshot policy |
| RetentionDays | integer | no | The number of days to retain automatic snapshots |
| RepeatWeekdays | string | no | A list of days of the week when automatic snapshots repeat. Valid values: 1 to 7. For example, 1 means Monday. Format rules: Pass the… |
| TimePoints | string | no | The times at which to create automatic snapshots. Times are specified in UTC+8 and must be integers from 0 to 23, representing the hour of… |
| RegionId | string | yes | The ID of the region. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |

### Modifies the name and description of a snapshot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/modify-snapshot-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. Call DescribeRegions to query the latest list of Alibaba Cloud regions |
| SnapshotId | string | yes | The snapshot ID |
| SnapshotName | string | no | The display name of the snapshot. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and… |
| Description | string | no | The description of the snapshot. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.… |

### Renames a database file system (DBFS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/rename-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| FsName | string | yes | The new name of the DBFS. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and can… |
| FsId | string | yes | The ID of the DBFS |
| RegionId | string | yes | The ID of the region where the DBFS instance is located. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view… |

### Call ResizeDbfs to resize a DBFS (database file system)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/resize-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the DBFS instance. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest Alibaba… |
| FsId | string | yes | The ID of the database file system |
| NewSizeG | integer | yes | The capacity of the database file system after resizing. It must be greater than its capacity before resizing. Unit: GiB |

### Call TagDbfs to assign tags to a DBFS (database file system)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/tag-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Call DescribeRegions (https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions |
| DbfsId | string | yes | The ID of the database file system |
| Tags | string | yes | The list of tags to set. TagKey: The tag key of the resource. The tag key can be up to 64 characters in length and can contain uppercase… |

### Update the instance type and scenario of a Database File System (DBFS) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/update-dbfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the DBFS instance resides. To view the latest list of Alibaba Cloud regions, see DescribeRegions… |
| FsId | string | yes | The ID of the Database File System (DBFS) instance |
| UsedScene | string | no | The updated scenario. Valid values: MySQL 5.7 PostgreSQL MongoDB Oracle RAC |
| InstanceType | string | no | The updated instance type. Valid values: dbfs.small dbfs.medium dbfs.large (default) |
| AdvancedFeatures | string | no | Customize CPU core count, maximum memory size, and page cache size for the DBFS instance |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dbfs.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/add-tags-batch" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Database File System API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dbfs/add-tags-batch with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Database File System API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Database File System itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Database File System API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dbfs.

### What is the status of the Alibaba Cloud Database File System API?
Needs your own provider key (bring your own key)