Skip to main content
Every object in an existing Alibaba Cloud OSS bucket becomes a file, and every / in a key becomes a folder.

Setup

Create an AccessKey pair for a RAM user in the RAM console, then export it.
  1. Open Identities > Users and create or pick a RAM user. Grant it AliyunOSSReadOnlyAccess, or AliyunOSSFullAccess for a write mount.
  2. Click the user’s name and, in the AccessKey section of its credential tab, click Create AccessKey.
  3. Copy the AccessKey ID and AccessKey Secret. The secret is shown only once.
  4. Note the bucket’s region, for example cn-hangzhou.
Use a RAM user’s key, not the root account’s. Each RAM user holds at most two AccessKey pairs.

Connect

workspace.yaml

Layout

  • The endpoint comes from region: s3.oss-<region>.aliyuncs.com, the S3-compatible host, not the native oss-<region>.aliyuncs.com. endpoint_url (endpoint in TypeScript) overrides it.
  • key_prefix (keyPrefix in TypeScript) mounts one folder of the bucket as the root.
  • grep -r, find and du stop after 1000 files; a glob matching more, tar -c, cp -r and rm -r are refused.

Sample runs

On a write mount, cp, mv, rm and > change objects in the bucket. For write: conditional, see S3-compatible VFSes.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.