Alibaba Cloud Object Storage Service

https://help.aliyun.com/zh/oss/
Admin
Alibaba Cloud Object Storage Service (OSS) is a cloud-based object storage service that provides...
Tokens:25,140
Snippets:176
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Initialize ossutil Configuration

Source: https://help.aliyun.com/zh/oss/command-line-options

Start the configuration process for ossutil.

```bash
ossutil config
```

--------------------------------

### Stat Bucket (Original Output)

Source: https://help.aliyun.com/zh/oss/command-line-options

Example of the default output for the stat command.

```bash
ossutil stat oss://bucketexample
ACL                         : private
AccessMonitor               : Disabled
ArchiveObjectCount          : 2
ArchiveRealStorage          : 10
ArchiveStorage              : 131072
...
StandardObjectCount         : 119212
StandardStorage             : 66756852803
Storage                     : 66756852813
StorageClass                : Standard
TransferAcceleration        : Disabled
```

--------------------------------

### Get Bucket CORS Configuration (Default Output)

Source: https://help.aliyun.com/zh/oss/command-line-options

Example of the default output format for the get-bucket-cors command.

```bash
ossutil api get-bucket-cors --bucket bucketexample
<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration>
  <CORSRule>
    <AllowedOrigin>www.aliyun.com</AllowedOrigin>
    <AllowedMethod>PUT</AllowedMethod>
    <AllowedMethod>GET</AllowedMethod>
    <MaxAgeSeconds>10000</MaxAgeSeconds>
  </CORSRule>
  <ResponseVary>false</ResponseVary>
</CORSConfiguration>
```

--------------------------------

### Stat Bucket (Human-Readable Output)

Source: https://help.aliyun.com/zh/oss/command-line-options

Example of using --human-readable to format byte and count data into human-readable units.

```bash
ossutil stat oss://bucketexample --human-readable
ACL                         : private
AccessMonitor               : Disabled
ArchiveObjectCount          : 2
ArchiveRealStorage          : 10
ArchiveStorage              : 131.072k
...
StandardObjectCount         : 119.212k
StandardStorage             : 66.757G
Storage                     : 66.757G
StorageClass                : Standard
TransferAcceleration        : Disabled
```

--------------------------------

### Get Bucket CORS Configuration (JSON Output)

Source: https://help.aliyun.com/zh/oss/command-line-options

Example of using --output-format json to convert the command output to JSON format.

```bash
ossutil api get-bucket-cors --bucket bucketexample --output-format json
{
  "CORSRule": {
    "AllowedMethod": [
      "PUT",
      "GET"
    ],
    "AllowedOrigin": "www.aliyun.com",
    "MaxAgeSeconds": "10000"
  },
  "ResponseVary": "false"
}
```

--------------------------------

### Configure ossutil Endpoint

Source: https://help.aliyun.com/zh/oss/command-line-options

Example of setting a custom internal endpoint during the ossutil configuration process.

```text
Please enter Endpoint (optional, use public endpoint by default) [None]: https://oss-cn-hangzhou-internal.aliyuncs.com
```

--------------------------------

### 使用默认配置文件运行 ossutil

Source: https://help.aliyun.com/zh/oss/command-line-options

当使用默认路径 ~/.ossutilconfig 时，直接运行命令即可。

```bash
ossutil ls oss://examplebucket
```

--------------------------------

### EcsRamRole 模式配置文件

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置 EcsRamRole 模式。

```ini
[default]
mode = EcsRamRole
# ecsRoleName可以不设置，当不设置时，自动获取。
ecsRoleName = EcsRamRoleOss 
region=cn-hangzhou
```

--------------------------------

### Create OSS Bucket

Source: https://help.aliyun.com/zh/oss/command-line-options

Create a new bucket and view the elapsed time output.

```bash
ossutil mb oss://examplebucket
```

```text
0.668238(s) elapsed
```

--------------------------------

### Upload File to Bucket

Source: https://help.aliyun.com/zh/oss/command-line-options

Create a local file and upload it to the specified bucket.

```bash
echo 'Hello, OSS!' > uploadFile.txt
```

```bash
ossutil cp uploadFile.txt oss://examplebucket
```

```text
Success: Total 1 file, size 12 B, Upload done:(1 objects, 12 B), avg 44 B/s

0.271779(s) elapsed
```

--------------------------------

### Filter Output with JMESPath

Source: https://help.aliyun.com/zh/oss/command-line-options

Example of using --output-query to filter specific fields from the JSON output.

```bash
ossutil api get-bucket-cors --bucket bucketexample --output-query CORSRule.AllowedMethod --output-format json
[
  "PUT",
  "GET"
]
```

--------------------------------

### Windows配置环境变量

Source: https://help.aliyun.com/zh/oss/command-line-options

在Windows CMD中使用setx设置环境变量，并在新的CMD窗口中验证。

```batch
setx OSS_ACCESS_KEY_ID "your-access-key-id"
setx OSS_ACCESS_KEY_SECRET "your-access-key-secret"
```

```batch
echo %OSS_ACCESS_KEY_ID%
echo %OSS_ACCESS_KEY_SECRET%
```

--------------------------------

### EcsRamRole 模式查询

Source: https://help.aliyun.com/zh/oss/command-line-options

使用配置文件或命令行参数查询 OSS 对象。

```bash
ossutil ls oss://examplebucket -c ~/.ossutilconfig
```

```bash
ossutil ls oss://examplebucket --mode EcsRamRole
```

--------------------------------

### EcsRamRole IMDSv2 模式配置文件

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置 Ali-EcsRamRole 模式。

```ini
[default]
mode = Ali-EcsRamRole
# ecsRoleName可以不设置，当不设置时，自动获取。
ecsRoleName = EcsRamRoleOss 
region=cn-hangzhou
```

--------------------------------

### OIDCRoleARN 配置文件

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置 oidcRoleArn 模式。

```ini
[default]
mode = oidcRoleArn
#指定 OIDC 提供者的 ARN（Aliyun Resource Name），格式为 acs:ram::account-id:oidc-provider/provider-name。
OIDCProviderArn=acs:ram::113511544585****:oidc-provider/TestOidcProvider
#指定 OIDC 令牌的文件路径，用于存储 OIDC 令牌
OIDCTokenFilePath=OIDCTokenFilePath
#填写角色的ARN信息，即需要扮演的角色ID。格式为acs:ram::113511544585****:oidc-provider/TestOidcProvider
roleArn=acs:ram::113511544585****:role/testoidc
# 自定义角色会话名称，用于区分不同的令牌。
roleSessionName= TestOidcAssumedRoleSession
region=cn-hangzhou
```

--------------------------------

### RAM 用户 AK 配置文件

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置 RAM 用户的 AccessKeyID 和 AccessKeySecret。

```ini
[default]
accessKeyID = yourAccessKeyID
accessKeySecret = yourAccessKeySecret
region=cn-hangzhou
```

--------------------------------

### RAMRoleARN 配置文件

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置 RAMRoleARN 认证模式。

```ini
[default]
accessKeyID = yourAccessKeyID
accessKeySecret = yourAccessKeySecret
mode = RamRoleArn
roleArn = acs:ram::137918634953****:role/Alice
roleSessionName = session_name_example
region=cn-hangzhou
```

--------------------------------

### Set ossutil Configuration File Path

Source: https://help.aliyun.com/zh/oss/command-line-options

Prompt for specifying the configuration file path.

```text
Please enter the config file name,the file name can include path(default "/Users/user/.ossutilconfig", carriage return will use the default file. If you specified this option to other file, you should specify --config-file option to the file when you use other commands): 
```

--------------------------------

### 配置外部进程凭证

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置使用外部进程获取凭证。

```ini
[default]
mode = Process
credentialProcess = user-cmd
region=cn-hangzhou
```

--------------------------------

### 从标准输入加载参数

Source: https://help.aliyun.com/zh/oss/command-line-options

使用管道将文件内容通过标准输入传递给命令，参数值设为 -。

```bash
cat cors-configuration.json | ossutil api put-bucket-cors --bucket examplebucket --cors-configuration -
```

--------------------------------

### 配置 buckets 节格式

Source: https://help.aliyun.com/zh/oss/command-line-options

用于配置特定 Bucket 和访问点的映射关系，支持嵌套写法。

```ini
[buckets name]
bucket-name = 
  key=value
```

--------------------------------

### 配置 ossutil (Windows)

Source: https://help.aliyun.com/zh/oss/command-line-options

在 Windows 系统上运行配置向导，设置配置文件路径、AccessKey ID、AccessKey Secret 和地域。

```bash
ossutil config
```

```bash
Please enter the config file name,the file name can include path(default "C:\Users\issuser\.ossutilconfig", carriage return will use the default file. If you specified this option to other file, you should specify --config-file option to the file when you use other commands):
```

```bash
Please enter Access Key ID [****************id]:yourAccessKeyID
```

```bash
Please enter Access Key Secret [****************sk]:yourAccessKeySecret
```

```bash
Please enter Region [cn-hangzhou]:cn-hangzhou
```

--------------------------------

### RAM 用户 AK 命令行查询

Source: https://help.aliyun.com/zh/oss/command-line-options

使用配置文件查询 OSS 对象。

```bash
ossutil ls oss://examplebucket -c ~/.ossutilconfig
```

--------------------------------

### 配置 ossutil (Linux)

Source: https://help.aliyun.com/zh/oss/command-line-options

在 Linux 系统上运行配置向导，设置配置文件路径、AccessKey ID、AccessKey Secret、地域和 Endpoint。

```bash
ossutil config
```

```bash
Please enter the config file name,the file name can include path(default /root/.ossutilconfig, carriage return will use the default file. If you specified this option to other file, you should specify --config-file option to the file when you use other commands):
```

```bash
Please enter Access Key ID [****************id]:yourAccessKeyID
```

```bash
Please enter Access Key Secret [****************sk]:yourAccessKeySecret
```

```bash
Please enter Region [cn-hangzhou]:cn-hangzhou
```

```bash
Please enter Endpoint (optional, use public endpoint by default) [None]: https://oss-cn-hangzhou-internal.aliyuncs.com
```

--------------------------------

### Global Command-Line Options

Source: https://help.aliyun.com/zh/oss/command-line-options

A list of global options that can be applied to most ossutil commands to configure authentication, connection settings, and output formats.

```APIDOC
## Global Options

- **-i, --access-key-id** (string) - AccessKey ID for OSS authentication.
- **-k, --access-key-secret** (string) - AccessKey Secret for OSS authentication.
- **--addressing-style** (string) - Request address format: virtual (default), path, or cname.
- **-c, --config-file** (string) - Path to the configuration file (default: ~/.ossutilconfig).
- **--connect-timeout** (int) - Client connection timeout in seconds (default: 10).
- **-n, --dry-run** (flag) - Perform a trial run without making changes.
- **-e, --endpoint** (string) - Service access domain name.
- **-h, --help** (flag) - Display help information.
- **--language** (string) - Display language.
- **--loglevel** (string) - Log level: off (default), info, debug.
- **--mode** (string) - Authentication mode: AK, StsToken, EcsRamRole, Anonymous.
- **--output-format** (string) - Output format (default: raw).
- **--output-query** (string) - JMESPath query condition.
- **--profile** (string) - Specify the profile in the configuration file.
- **-q, --quiet** (flag) - Quiet mode, print minimal information.
- **--read-timeout** (int) - Client read/write timeout in seconds (default: 20).
- **--region** (string) - Region of the data center.
- **--retry-times** (int) - Number of retries on error (default: 10).
- **--sign-version** (string) - Signature version: v1, v4 (default).
- **--skip-verify-cert** (flag) - Skip verification of server digital certificates.
- **-t, --sts-token** (string) - STS Token for OSS authentication.
- **--proxy** (string) - Proxy server configuration (URL or 'env').
- **--log-file** (string) - Log output file path or '-' for stdout.
- **--cloudbox-id** (string) - Cloudbox ID for cloudbox scenarios.
- **--ignore-env-var** (flag) - Ignore environment variables prefixed with OSS_.
- **--bind-address** (string) - Local IP address for outbound connections.
- **--account-id** (string) - Account ID for resource identification.
- **--user-agent** (string) - Append custom value to the default User-Agent.
```

--------------------------------

### STS 临时访问凭证配置文件

Source: https://help.aliyun.com/zh/oss/command-line-options

在 ~/.ossutilconfig 文件中配置 STS 临时凭证。

```ini
[default]
accessKeyID = yourSTSAccessKeyID
accessKeySecret = yourSTSAccessKeySecret
stsToken = yourSecurityToken
region=cn-hangzhou
```

--------------------------------

### Download File from Bucket

Source: https://help.aliyun.com/zh/oss/command-line-options

Download an object from the bucket to a local folder.

```bash
ossutil cp oss://examplebucket/uploadFile.txt localfolder/
```

```text
Success: Total 1 object, size 12 B, Download done:(1 files, 12 B), avg 74 B/s

0.162447(s) elapsed
```

--------------------------------

### 验证 ossutil 安装 (Windows)

Source: https://help.aliyun.com/zh/oss/command-line-options

在 Windows 系统上通过执行 ossutil 命令验证安装是否成功。

```bash
ossutil
```

--------------------------------

### 配置 buckets 引用

Source: https://help.aliyun.com/zh/oss/command-line-options

在 profile 中引用 buckets 节的配置。

```ini
[profile dev]
region=cn-hangzhou
access-key-id=ak
access-key-secret=sk
buckets=dev-bucket

[buckets dev-bucket]
bucket-name-hz =
 endpoint=oss-cn-hangzhou-internal.aliyuncs.com
bucket-name-bj =
 region=cn-beijing
```

--------------------------------

### 配置 source-profile 引用

Source: https://help.aliyun.com/zh/oss/command-line-options

通过 source-profile 参数引用其他 profile 中的配置项。

```ini
[profile cred]
access-key-id=ak
access-key-secret=sk

[profile dev]
region=cn-hangzhou
source-profile=cred
```

--------------------------------

### ossutil sync command format

Source: https://help.aliyun.com/zh/oss/developer-reference/sync-synchronize-local-files-to-oss?spm=a2c4g.11186623.help-menu-31815.d_19_3_1_2_0_16_0.3f704c8c0UvPzV&scm=20140722.H_2788837._.OR_help-T_cn~zh-V_1

The basic syntax for synchronizing a local directory to an OSS bucket.

```bash
ossutil sync file_url cloud_url
```

--------------------------------

### 安装 unzip 工具 (Ubuntu)

Source: https://help.aliyun.com/zh/oss/command-line-options

在 Ubuntu 系统上安装 unzip 解压工具。

```bash
sudo apt install -y unzip
```

--------------------------------

### Linux配置环境变量

Source: https://help.aliyun.com/zh/oss/command-line-options

在Linux系统中将OSS访问密钥追加到~/.bashrc文件，使其生效并验证。

```bash
echo "export OSS_ACCESS_KEY_ID='your-access-key-id'" >> ~/.bashrc
echo "export OSS_ACCESS_KEY_SECRET='your-access-key-secret'" >> ~/.bashrc
```

```bash
source  ~/.bashrc
```

```bash
echo $OSS_ACCESS_KEY_ID
echo $OSS_ACCESS_KEY_SECRET
```

--------------------------------

### 安装 unzip 工具 (Alibaba Cloud Linux/CentOS)

Source: https://help.aliyun.com/zh/oss/command-line-options

在 Alibaba Cloud Linux 或 CentOS 系统上安装 unzip 解压工具。

```bash
sudo yum install -y unzip
```

--------------------------------

### 使用带参数的命令

Source: https://help.aliyun.com/zh/oss/command-line-options

展示如何通过参数值指定配置文件，以及处理包含空格的参数值。

```bash
ossutil ls --profile dev
```

```bash
--description "OSS bucket list"
```

--------------------------------

### EcsRamRole IMDSv2 模式查询

Source: https://help.aliyun.com/zh/oss/command-line-options

使用配置文件或命令行参数查询 OSS 对象。

```bash
ossutil ls oss://examplebucket -c ~/.ossutilconfig
```

```bash
ossutil ls oss://examplebucket --mode Ali-EcsRamRole
```

--------------------------------

### RAM 用户 AK 环境变量查询

Source: https://help.aliyun.com/zh/oss/command-line-options

通过环境变量设置凭证并查询 OSS 对象。

```bash
export OSS_ACCESS_KEY_ID=yourAccessKeyID
export OSS_ACCESS_KEY_SECRET=yourAccessKeySecret
ossutil ls oss://examplebucket
```

--------------------------------

### 配置代理服务器环境变量

Source: https://help.aliyun.com/zh/oss/command-line-options

在操作系统中配置环境变量以供 ossutil 使用代理。

```bash
HTTP_PROXY=http://proxy.example.com:8080
HTTPS_PROXY=https://proxy.example.com:8443
```

--------------------------------

### RAM 用户 AK 命令行选项查询

Source: https://help.aliyun.com/zh/oss/command-line-options

直接在命令行中指定 AccessKeyID 和 AccessKeySecret 进行查询。

```bash
ossutil ls oss://examplebucket -i yourAccessKeyID -k yourAccessKeySecret
```

--------------------------------

### 安装 ossutil (macOS ARM64)

Source: https://help.aliyun.com/zh/oss/command-line-options

在 macOS ARM64 系统上下载、解压、设置权限并配置全局调用 ossutil 的完整流程。

```bash
curl -o ossutil-2.4.0-mac-arm64.zip  https://gosspublic.alicdn.com/ossutil/v2/2.4.0/ossutil-2.4.0-mac-arm64.zip
```

```bash
unzip ossutil-2.4.0-mac-arm64.zip
```

```bash
cd ossutil-2.4.0-mac-arm64
```

```bash
chmod 755 ossutil
```

```bash
sudo mv ossutil /usr/local/bin/ && sudo ln -s /usr/local/bin/ossutil /usr/bin/ossutil
```

```bash
ossutil
```

--------------------------------

### 使用自定义配置文件路径

Source: https://help.aliyun.com/zh/oss/command-line-options

通过 -c 选项指定自定义的配置文件路径。

```bash
ossutil -c /path/yourconfig ls oss://examplebucket
```

--------------------------------

### 使用ossutil命令行选项

Source: https://help.aliyun.com/zh/oss/command-line-options

通过命令行选项直接传入访问密钥和区域参数，该方式优先级最高。

```bash
ossutil ls oss://examplebucket -i "your-access-key-id" -k "your-access-key-secret" --region cn-hangzhou
```

--------------------------------

### Command Structure and Parameter Loading

Source: https://help.aliyun.com/zh/oss/command-line-options

General syntax for executing ossutil commands and loading complex parameters from files or standard input.

```APIDOC
## Command Syntax

### Usage
ossutil command [argument] [flags]
ossutil command subcommand [argument] [flags]

### Parameter Loading
- **file://path**: Load parameter value from a file.
- **-**: Load parameter value from standard input.

### Example (File Loading)
ossutil api put-bucket-cors --bucket examplebucket --cors-configuration file://cors-configuration.json

### Example (Standard Input)
cat cors-configuration.json | ossutil api put-bucket-cors --bucket examplebucket --cors-configuration -
```
Tokens:
Raw