diff --git a/docs/reference/command-lines/utilities/metadata.md b/docs/reference/command-lines/utilities/metadata.md index 52d469790..1d35d0abd 100644 --- a/docs/reference/command-lines/utilities/metadata.md +++ b/docs/reference/command-lines/utilities/metadata.md @@ -17,6 +17,8 @@ greptime cli meta snapshot save [OPTIONS] ### Options +#### Storage Backend Options + | Option | Required | Default | Description | | ------------------ | -------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | --store-addrs | Yes | - | Metadata storage service addresses to connect to (only supports etcd MySQL PostgreSQL) format consistent with store-addrs in metasrv configuration | @@ -24,14 +26,65 @@ greptime cli meta snapshot save [OPTIONS] | --store-key-prefix | No | "" | Unified prefix for data in metasrv, refer to metasrv configuration | | --meta-table-name | No | greptime_metakv | When backend is one of `postgres-store`, `mysql-store`, the table name storing metadata | | --max-txn-ops | No | 128 | Maximum number of txn operations | -| --file-name | No | metadata_snapshot | File name for metadata export, will automatically add `.metadata.fb` suffix | -| --output-dir | No | "" | Directory to store exported data | -| --s3 | No | false | Whether to use s3 as storage medium for exported data | -| --s3-bucket | No | - | Valid when s3 is true, s3 bucket name | -| --s3-region | No | - | Valid when s3 is true, s3 region name | -| --s3-access-key | No | - | Valid when s3 is true, s3 access key name | -| --s3-secret-key | No | - | Valid when s3 is true, s3 secret key name | -| --s3-endpoint | No | - | Valid when s3 is true, s3 endpoint name, defaults based on bucket region, generally not needed | + +#### File Options + +| Option | Required | Default | Description | +| ------------ | -------- | ----------------- | --------------------------------------------------------------------------- | +| --file-name | No | metadata_snapshot | File name for metadata export, will automatically add `.metadata.fb` suffix | +| --dir | No | "" | Directory to store exported data | + +#### Object Storage Options + +To use object storage for storing exported metadata, enable one of the following providers and configure its connection parameters: + +##### S3 + +| Option | Required | Default | Description | +| ---------------------------- | -------- | ------- | ---------------------------------------------------------------- | +| --enable-s3 | No | false | Whether to use S3 as storage medium for exported data | +| --s3-bucket | No | - | S3 bucket name | +| --s3-root | No | - | Root path in S3 bucket | +| --s3-access-key-id | No | - | S3 access key ID | +| --s3-secret-access-key | No | - | S3 secret access key | +| --s3-region | No | - | S3 region name | +| --s3-endpoint | No | - | S3 endpoint URL (optional, defaults based on bucket region) | +| --s3-enable-virtual-host-style | No | false | Enable virtual host style for S3 API requests | + +##### OSS (Alibaba Cloud) + +| Option | Required | Default | Description | +| ----------------------- | -------- | ------- | -------------------------------------- | +| --enable-oss | No | false | Whether to use OSS for exported data | +| --oss-bucket | No | - | OSS bucket name | +| --oss-root | No | - | Root path in OSS bucket | +| --oss-access-key-id | No | - | OSS access key ID | +| --oss-access-key-secret | No | - | OSS access key secret | +| --oss-endpoint | No | - | OSS endpoint URL | + +##### GCS (Google Cloud Storage) + +| Option | Required | Default | Description | +| --------------------- | -------- | ------- | ------------------------------------- | +| --enable-gcs | No | false | Whether to use GCS for exported data | +| --gcs-bucket | No | - | GCS bucket name | +| --gcs-root | No | - | Root path in GCS bucket | +| --gcs-scope | No | - | GCS service scope | +| --gcs-credential-path | No | - | Path to GCS credential file | +| --gcs-credential | No | - | GCS credential content | +| --gcs-endpoint | No | - | GCS endpoint URL | + +##### Azure Blob Storage + +| Option | Required | Default | Description | +| --------------------- | -------- | ------- | ------------------------------------------- | +| --enable-azblob | No | false | Whether to use Azure Blob for exported data | +| --azblob-container | No | - | Azure Blob container name | +| --azblob-root | No | - | Root path in container | +| --azblob-account-name | No | - | Azure Blob account name | +| --azblob-account-key | No | - | Azure Blob account key | +| --azblob-endpoint | No | - | Azure Blob endpoint URL | +| --azblob-sas-token | No | - | Azure Blob SAS token | @@ -45,19 +98,145 @@ greptime cli meta snapshot restore [OPTIONS] ### Options -| Option | Required | Default | Description | -| ------------------ | -------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| --store-addrs | Yes | - | Metadata storage service addresses to connect to (only supports etcd MySQL PostgreSQL) format consistent with store-addrs in metasrv configuration | -| --backend | Yes | - | Type of metadata storage backend, one of `etcd-store`, `postgres-store`, `mysql-store` | -| --store-key-prefix | No | "" | Unified prefix for data in metasrv, refer to metasrv configuration | -| --meta-table-name | No | greptime_metakv | When backend is `postgres-store`, `mysql-store`, the table name storing metadata | -| --max-txn-ops | No | 128 | Maximum number of txn operations | -| --file-name | No | metadata_snapshot.metadata.fb | File name of metadata export to import, will automatically add `.metadata.fb` suffix | -| --input-dir | No | "" | Directory storing exported data | -| --s3 | No | false | Whether to use s3 as storage medium for exported data | -| --s3-bucket | No | - | Valid when s3 is true, s3 bucket name | -| --s3-region | No | - | Valid when s3 is true, s3 region name | -| --s3-access-key | No | - | Valid when s3 is true, s3 access key name | -| --s3-secret-key | No | - | Valid when s3 is true, s3 secret key name | -| --s3-endpoint | No | - | Valid when s3 is true, s3 endpoint name, defaults based on bucket region, generally not needed | -| --force | No | false | Whether to force import, when target backend is detected to not be in a clean state, import is disabled by default, enable this flag to force import | +#### Storage Backend Options + +| Option | Required | Default | Description | +| ------------------ | -------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| --store-addrs | Yes | - | Metadata storage service addresses to connect to (only supports etcd MySQL PostgreSQL) format consistent with store-addrs in metasrv configuration | +| --backend | Yes | - | Type of metadata storage backend, one of `etcd-store`, `postgres-store`, `mysql-store` | +| --store-key-prefix | No | "" | Unified prefix for data in metasrv, refer to metasrv configuration | +| --meta-table-name | No | greptime_metakv | When backend is `postgres-store`, `mysql-store`, the table name storing metadata | +| --max-txn-ops | No | 128 | Maximum number of txn operations | + +#### File Options + +| Option | Required | Default | Description | +| ----------- | -------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| --file-name | No | metadata_snapshot.metadata.fb | File name of metadata export to import | +| --dir | No | "." | Directory storing exported data | +| --force | No | false | Whether to force import, when target backend is detected to not be in a clean state, import is disabled by default, enable this flag to force import | + +#### Object Storage Options + +To use object storage for importing metadata, enable one of the following providers and configure its connection parameters: + +##### S3 + +| Option | Required | Default | Description | +| ---------------------------- | -------- | ------- | ---------------------------------------------------------------- | +| --enable-s3 | No | false | Whether to use S3 as storage medium for exported data | +| --s3-bucket | No | - | S3 bucket name | +| --s3-root | No | - | Root path in S3 bucket | +| --s3-access-key-id | No | - | S3 access key ID | +| --s3-secret-access-key | No | - | S3 secret access key | +| --s3-region | No | - | S3 region name | +| --s3-endpoint | No | - | S3 endpoint URL (optional, defaults based on bucket region) | +| --s3-enable-virtual-host-style | No | false | Enable virtual host style for S3 API requests | + +##### OSS (Alibaba Cloud) + +| Option | Required | Default | Description | +| ----------------------- | -------- | ------- | -------------------------------------- | +| --enable-oss | No | false | Whether to use OSS for exported data | +| --oss-bucket | No | - | OSS bucket name | +| --oss-root | No | - | Root path in OSS bucket | +| --oss-access-key-id | No | - | OSS access key ID | +| --oss-access-key-secret | No | - | OSS access key secret | +| --oss-endpoint | No | - | OSS endpoint URL | + +##### GCS (Google Cloud Storage) + +| Option | Required | Default | Description | +| --------------------- | -------- | ------- | ------------------------------------- | +| --enable-gcs | No | false | Whether to use GCS for exported data | +| --gcs-bucket | No | - | GCS bucket name | +| --gcs-root | No | - | Root path in GCS bucket | +| --gcs-scope | No | - | GCS service scope | +| --gcs-credential-path | No | - | Path to GCS credential file | +| --gcs-credential | No | - | GCS credential content | +| --gcs-endpoint | No | - | GCS endpoint URL | + +##### Azure Blob Storage + +| Option | Required | Default | Description | +| --------------------- | -------- | ------- | ------------------------------------------- | +| --enable-azblob | No | false | Whether to use Azure Blob for exported data | +| --azblob-container | No | - | Azure Blob container name | +| --azblob-root | No | - | Root path in container | +| --azblob-account-name | No | - | Azure Blob account name | +| --azblob-account-key | No | - | Azure Blob account key | +| --azblob-endpoint | No | - | Azure Blob endpoint URL | +| --azblob-sas-token | No | - | Azure Blob SAS token | + +## Info Tool + +The Info tool allows you to view the contents of a metadata snapshot without restoring it. + +### Command Syntax + +```bash +greptime cli meta snapshot info [OPTIONS] +``` + +### Options + +#### File Options + +| Option | Required | Default | Description | +| ------------ | -------- | ----------------- | ------------------------------------------- | +| --file-name | No | metadata_snapshot | File name of the metadata snapshot to view | +| --dir | No | "." | Directory where the snapshot file is stored | +| --inspect-key| No | "*" | Query pattern to filter metadata keys | +| --limit | No | - | Maximum number of entries to display | + +#### Object Storage Options + +To inspect snapshots stored in object storage, enable one of the following providers and configure its connection parameters: + +##### S3 + +| Option | Required | Default | Description | +| ---------------------------- | -------- | ------- | ---------------------------------------------------------------- | +| --enable-s3 | No | false | Whether to use S3 as storage medium for the snapshot | +| --s3-bucket | No | - | S3 bucket name | +| --s3-root | No | - | Root path in S3 bucket | +| --s3-access-key-id | No | - | S3 access key ID | +| --s3-secret-access-key | No | - | S3 secret access key | +| --s3-region | No | - | S3 region name | +| --s3-endpoint | No | - | S3 endpoint URL (optional, defaults based on bucket region) | +| --s3-enable-virtual-host-style | No | false | Enable virtual host style for S3 API requests | + +##### OSS (Alibaba Cloud) + +| Option | Required | Default | Description | +| ----------------------- | -------- | ------- | -------------------------------------- | +| --enable-oss | No | false | Whether to use OSS for the snapshot | +| --oss-bucket | No | - | OSS bucket name | +| --oss-root | No | - | Root path in OSS bucket | +| --oss-access-key-id | No | - | OSS access key ID | +| --oss-access-key-secret | No | - | OSS access key secret | +| --oss-endpoint | No | - | OSS endpoint URL | + +##### GCS (Google Cloud Storage) + +| Option | Required | Default | Description | +| --------------------- | -------- | ------- | ------------------------------------- | +| --enable-gcs | No | false | Whether to use GCS for the snapshot | +| --gcs-bucket | No | - | GCS bucket name | +| --gcs-root | No | - | Root path in GCS bucket | +| --gcs-scope | No | - | GCS service scope | +| --gcs-credential-path | No | - | Path to GCS credential file | +| --gcs-credential | No | - | GCS credential content | +| --gcs-endpoint | No | - | GCS endpoint URL | + +##### Azure Blob Storage + +| Option | Required | Default | Description | +| --------------------- | -------- | ------- | ------------------------------------------- | +| --enable-azblob | No | false | Whether to use Azure Blob for the snapshot | +| --azblob-container | No | - | Azure Blob container name | +| --azblob-root | No | - | Root path in container | +| --azblob-account-name | No | - | Azure Blob account name | +| --azblob-account-key | No | - | Azure Blob account key | +| --azblob-endpoint | No | - | Azure Blob endpoint URL | +| --azblob-sas-token | No | - | Azure Blob SAS token | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata.md b/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata.md index b1fbd1259..f50c814a0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata.md @@ -17,6 +17,8 @@ greptime cli meta snapshot save [OPTIONS] ### 选项 +#### 存储后端选项 + | 选项 | 是否必需 | 默认值 | 描述 | | ------------------ | -------- | ----------------- | ------------------------------------------------------------------------------------------------------ | | --store-addrs | 是 | - | 要连接的元数据存储服务地址（仅支持 etcd、MySQL、PostgreSQL），格式与 Metasrv 配置中的 store-addrs 一致 | @@ -24,14 +26,65 @@ greptime cli meta snapshot save [OPTIONS] | --store-key-prefix | 否 | "" | 元数据存储前缀，参考 Metasrv 配置 | | --meta-table-name | 否 | greptime_metakv | 当后端为 `postgres-store` 或 `mysql-store` 时，元数据存储的表名 | | --max-txn-ops | 否 | 128 | 最大事务操作数 | -| --file-name | 否 | metadata_snapshot | 元数据导出的文件名，会自动添加 `.metadata.fb` 后缀 | -| --output-dir | 否 | "" | 存储导出数据的目录 | -| --s3 | 否 | false | 是否导出至 s3 云存储 | -| --s3-bucket | 否 | - | 当 s3 为 true 时，s3 桶名 | -| --s3-region | 否 | - | 当 s3 为 true 时，s3区域名称 | -| --s3-access-key | 否 | - | 当 s3 为 true 时，访问 s3 的访问密钥 ID名 | -| --s3-secret-key | 否 | - | 当 s3 为 true 时，访问 s3 的访问密钥 | -| --s3-endpoint | 否 | - | 当 s3 为 true 时有效，s3 endpoint 的名称，默认会根据 s3 桶名称、区域得出，一般不需要设置要 | + +#### 文件选项 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ----------- | -------- | ----------------- | -------------------------------------------------- | +| --file-name | 否 | metadata_snapshot | 元数据导出的文件名，会自动添加 `.metadata.fb` 后缀 | +| --dir | 否 | "" | 存储导出数据的目录 | + +#### 对象存储选项 + +要使用对象存储来存储导出的元数据，请启用以下任一提供商并配置其连接参数： + +##### S3 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ------------------------------ | -------- | ------ | ------------------------------------------- | +| --enable-s3 | 否 | false | 是否使用 S3 作为导出数据的存储介质 | +| --s3-bucket | 否 | - | S3 桶名 | +| --s3-root | 否 | - | S3 桶中的根路径 | +| --s3-access-key-id | 否 | - | S3 访问密钥 ID | +| --s3-secret-access-key | 否 | - | S3 访问密钥 | +| --s3-region | 否 | - | S3 区域名称 | +| --s3-endpoint | 否 | - | S3 端点 URL（可选，默认根据桶区域确定） | +| --s3-enable-virtual-host-style | 否 | false | 为 S3 API 请求启用虚拟主机样式 | + +##### OSS（阿里云） + +| 选项 | 是否必需 | 默认值 | 描述 | +| ----------------------- | -------- | ------ | ---------------------------------- | +| --enable-oss | 否 | false | 是否使用 OSS 作为导出数据的存储介质 | +| --oss-bucket | 否 | - | OSS 桶名 | +| --oss-root | 否 | - | OSS 桶中的根路径 | +| --oss-access-key-id | 否 | - | OSS 访问密钥 ID | +| --oss-access-key-secret | 否 | - | OSS 访问密钥 | +| --oss-endpoint | 否 | - | OSS 端点 URL | + +##### GCS（谷歌云存储） + +| 选项 | 是否必需 | 默认值 | 描述 | +| --------------------- | -------- | ------ | ---------------------------------- | +| --enable-gcs | 否 | false | 是否使用 GCS 作为导出数据的存储介质 | +| --gcs-bucket | 否 | - | GCS 桶名 | +| --gcs-root | 否 | - | GCS 桶中的根路径 | +| --gcs-scope | 否 | - | GCS 服务范围 | +| --gcs-credential-path | 否 | - | GCS 凭证文件路径 | +| --gcs-credential | 否 | - | GCS 凭证内容 | +| --gcs-endpoint | 否 | - | GCS 端点 URL | + +##### Azure Blob 存储 + +| 选项 | 是否必需 | 默认值 | 描述 | +| --------------------- | -------- | ------ | ---------------------------------------- | +| --enable-azblob | 否 | false | 是否使用 Azure Blob 作为导出数据的存储介质 | +| --azblob-container | 否 | - | Azure Blob 容器名称 | +| --azblob-root | 否 | - | 容器中的根路径 | +| --azblob-account-name | 否 | - | Azure Blob 账户名称 | +| --azblob-account-key | 否 | - | Azure Blob 账户密钥 | +| --azblob-endpoint | 否 | - | Azure Blob 端点 URL | +| --azblob-sas-token | 否 | - | Azure Blob SAS 令牌 | ## 导入工具 @@ -43,19 +96,145 @@ greptime cli meta snapshot restore [OPTIONS] ### 选项 -| 选项 | 是否必需 | 默认值 | 描述 | -| ------------------ | -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------ | -| --store-addrs | 是 | - | 要连接的元数据存储服务地址（仅支持 etcd、MySQL、PostgreSQL），格式与 Metasrv 配置中的 store-addrs 一致 | -| --backend | 是 | - | 元数据存储后端类型，支持 `etcd-store`、`postgres-store`、`mysql-store` | -| --store-key-prefix | 否 | "" | 元数据存储的 key 前缀，参考 Metasrv 配置 | -| --meta-table-name | 否 | greptime_metakv | 当后端为 `postgres-store` 或 `mysql-store` 时，元数据存储的表名 | -| --max-txn-ops | 否 | 128 | 最大事务操作数 | -| --file-name | 否 | metadata_snapshot.metadata.fb | 元数据导出的文件名，会自动添加 `.metadata.fb` 后缀 | -| --input-dir | 否 | "" | 存储导出数据的目录 | -| --s3 | 否 | false | 是否导入 s3 云存储 | -| --s3-bucket | 否 | - | 当 s3 为 true 时，s3 桶名 | -| --s3-region | 否 | - | 当 s3 为 true 时，s3区域名称 | -| --s3-access-key | 否 | - | 当 s3 为 true 时，访问 s3 的访问密钥 ID名 | -| --s3-secret-key | 否 | - | 当 s3 为 true 时，访问 s3 的访问密钥 | -| --s3-endpoint | 否 | - | 当 s3 为 true 时有效，s3 endpoint 的名称，默认会根据 s3 桶名称、区域得出，一般不需要设置要 | -| --force | 否 | false | 是否强制导入，当目标后端检测包含旧数据时，默认无法导入数据，若想强制导入则可开启此标志 | +#### 存储后端选项 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ------------------ | -------- | --------------- | ------------------------------------------------------------------------------------------------------ | +| --store-addrs | 是 | - | 要连接的元数据存储服务地址（仅支持 etcd、MySQL、PostgreSQL），格式与 Metasrv 配置中的 store-addrs 一致 | +| --backend | 是 | - | 元数据存储后端类型，支持 `etcd-store`、`postgres-store`、`mysql-store` | +| --store-key-prefix | 否 | "" | 元数据存储的 key 前缀，参考 Metasrv 配置 | +| --meta-table-name | 否 | greptime_metakv | 当后端为 `postgres-store` 或 `mysql-store` 时，元数据存储的表名 | +| --max-txn-ops | 否 | 128 | 最大事务操作数 | + +#### 文件选项 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ----------- | -------- | ----------------------------- | -------------------------------------------------------------------------------------- | +| --file-name | 否 | metadata_snapshot.metadata.fb | 元数据导出的文件名 | +| --dir | 否 | "." | 存储导出数据的目录 | +| --force | 否 | false | 是否强制导入，当目标后端检测包含旧数据时，默认无法导入数据，若想强制导入则可开启此标志 | + +#### 对象存储选项 + +要使用对象存储来导入元数据，请启用以下任一提供商并配置其连接参数： + +##### S3 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ------------------------------ | -------- | ------ | ------------------------------------------- | +| --enable-s3 | 否 | false | 是否使用 S3 作为导出数据的存储介质 | +| --s3-bucket | 否 | - | S3 桶名 | +| --s3-root | 否 | - | S3 桶中的根路径 | +| --s3-access-key-id | 否 | - | S3 访问密钥 ID | +| --s3-secret-access-key | 否 | - | S3 访问密钥 | +| --s3-region | 否 | - | S3 区域名称 | +| --s3-endpoint | 否 | - | S3 端点 URL（可选，默认根据桶区域确定） | +| --s3-enable-virtual-host-style | 否 | false | 为 S3 API 请求启用虚拟主机样式 | + +##### OSS（阿里云） + +| 选项 | 是否必需 | 默认值 | 描述 | +| ----------------------- | -------- | ------ | ---------------------------------- | +| --enable-oss | 否 | false | 是否使用 OSS 作为导出数据的存储介质 | +| --oss-bucket | 否 | - | OSS 桶名 | +| --oss-root | 否 | - | OSS 桶中的根路径 | +| --oss-access-key-id | 否 | - | OSS 访问密钥 ID | +| --oss-access-key-secret | 否 | - | OSS 访问密钥 | +| --oss-endpoint | 否 | - | OSS 端点 URL | + +##### GCS（谷歌云存储） + +| 选项 | 是否必需 | 默认值 | 描述 | +| --------------------- | -------- | ------ | ---------------------------------- | +| --enable-gcs | 否 | false | 是否使用 GCS 作为导出数据的存储介质 | +| --gcs-bucket | 否 | - | GCS 桶名 | +| --gcs-root | 否 | - | GCS 桶中的根路径 | +| --gcs-scope | 否 | - | GCS 服务范围 | +| --gcs-credential-path | 否 | - | GCS 凭证文件路径 | +| --gcs-credential | 否 | - | GCS 凭证内容 | +| --gcs-endpoint | 否 | - | GCS 端点 URL | + +##### Azure Blob 存储 + +| 选项 | 是否必需 | 默认值 | 描述 | +| --------------------- | -------- | ------ | ---------------------------------------- | +| --enable-azblob | 否 | false | 是否使用 Azure Blob 作为导出数据的存储介质 | +| --azblob-container | 否 | - | Azure Blob 容器名称 | +| --azblob-root | 否 | - | 容器中的根路径 | +| --azblob-account-name | 否 | - | Azure Blob 账户名称 | +| --azblob-account-key | 否 | - | Azure Blob 账户密钥 | +| --azblob-endpoint | 否 | - | Azure Blob 端点 URL | +| --azblob-sas-token | 否 | - | Azure Blob SAS 令牌 | + +## 信息工具 + +信息工具允许您查看元数据快照的内容而无需恢复它。 + +### 命令语法 + +```bash +greptime cli meta snapshot info [OPTIONS] +``` + +### 选项 + +#### 文件选项 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ------------- | -------- | ----------------- | ---------------------- | +| --file-name | 否 | metadata_snapshot | 要查看的元数据快照文件名 | +| --dir | 否 | "." | 快照文件存储的目录 | +| --inspect-key | 否 | "*" | 过滤元数据键的查询模式 | +| --limit | 否 | - | 显示的最大条目数 | + +#### 对象存储选项 + +要检查存储在对象存储中的快照，请启用以下任一提供商并配置其连接参数： + +##### S3 + +| 选项 | 是否必需 | 默认值 | 描述 | +| ------------------------------ | -------- | ------ | --------------------------------------- | +| --enable-s3 | 否 | false | 是否使用 S3 作为快照的存储介质 | +| --s3-bucket | 否 | - | S3 桶名 | +| --s3-root | 否 | - | S3 桶中的根路径 | +| --s3-access-key-id | 否 | - | S3 访问密钥 ID | +| --s3-secret-access-key | 否 | - | S3 访问密钥 | +| --s3-region | 否 | - | S3 区域名称 | +| --s3-endpoint | 否 | - | S3 端点 URL（可选，默认根据桶区域确定） | +| --s3-enable-virtual-host-style | 否 | false | 为 S3 API 请求启用虚拟主机样式 | + +##### OSS（阿里云） + +| 选项 | 是否必需 | 默认值 | 描述 | +| ----------------------- | -------- | ------ | ------------------------------ | +| --enable-oss | 否 | false | 是否使用 OSS 作为快照的存储介质 | +| --oss-bucket | 否 | - | OSS 桶名 | +| --oss-root | 否 | - | OSS 桶中的根路径 | +| --oss-access-key-id | 否 | - | OSS 访问密钥 ID | +| --oss-access-key-secret | 否 | - | OSS 访问密钥 | +| --oss-endpoint | 否 | - | OSS 端点 URL | + +##### GCS（谷歌云存储） + +| 选项 | 是否必需 | 默认值 | 描述 | +| --------------------- | -------- | ------ | ------------------------------ | +| --enable-gcs | 否 | false | 是否使用 GCS 作为快照的存储介质 | +| --gcs-bucket | 否 | - | GCS 桶名 | +| --gcs-root | 否 | - | GCS 桶中的根路径 | +| --gcs-scope | 否 | - | GCS 服务范围 | +| --gcs-credential-path | 否 | - | GCS 凭证文件路径 | +| --gcs-credential | 否 | - | GCS 凭证内容 | +| --gcs-endpoint | 否 | - | GCS 端点 URL | + +##### Azure Blob 存储 + +| 选项 | 是否必需 | 默认值 | 描述 | +| --------------------- | -------- | ------ | ------------------------------------ | +| --enable-azblob | 否 | false | 是否使用 Azure Blob 作为快照的存储介质 | +| --azblob-container | 否 | - | Azure Blob 容器名称 | +| --azblob-root | 否 | - | 容器中的根路径 | +| --azblob-account-name | 否 | - | Azure Blob 账户名称 | +| --azblob-account-key | 否 | - | Azure Blob 账户密钥 | +| --azblob-endpoint | 否 | - | Azure Blob 端点 URL | +| --azblob-sas-token | 否 | - | Azure Blob SAS 令牌 |