github.com/artpar/rclone@v1.67.3/docs/content/qingstor.md (about) 1 --- 2 title: "QingStor" 3 description: "Rclone docs for QingStor Object Storage" 4 versionIntroduced: "v1.38" 5 --- 6 7 # {{< icon "fas fa-hdd" >}} QingStor 8 9 Paths are specified as `remote:bucket` (or `remote:` for the `lsd` 10 command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. 11 12 ## Configuration 13 14 Here is an example of making an QingStor configuration. First run 15 16 rclone config 17 18 This will guide you through an interactive setup process. 19 20 ``` 21 No remotes found, make a new one? 22 n) New remote 23 r) Rename remote 24 c) Copy remote 25 s) Set configuration password 26 q) Quit config 27 n/r/c/s/q> n 28 name> remote 29 Type of storage to configure. 30 Choose a number from below, or type in your own value 31 [snip] 32 XX / QingStor Object Storage 33 \ "qingstor" 34 [snip] 35 Storage> qingstor 36 Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. 37 Choose a number from below, or type in your own value 38 1 / Enter QingStor credentials in the next step 39 \ "false" 40 2 / Get QingStor credentials from the environment (env vars or IAM) 41 \ "true" 42 env_auth> 1 43 QingStor Access Key ID - leave blank for anonymous access or runtime credentials. 44 access_key_id> access_key 45 QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 46 secret_access_key> secret_key 47 Enter an endpoint URL to connection QingStor API. 48 Leave blank will use the default value "https://qingstor.com:443" 49 endpoint> 50 Zone connect to. Default is "pek3a". 51 Choose a number from below, or type in your own value 52 / The Beijing (China) Three Zone 53 1 | Needs location constraint pek3a. 54 \ "pek3a" 55 / The Shanghai (China) First Zone 56 2 | Needs location constraint sh1a. 57 \ "sh1a" 58 zone> 1 59 Number of connection retry. 60 Leave blank will use the default value "3". 61 connection_retries> 62 Remote config 63 -------------------- 64 [remote] 65 env_auth = false 66 access_key_id = access_key 67 secret_access_key = secret_key 68 endpoint = 69 zone = pek3a 70 connection_retries = 71 -------------------- 72 y) Yes this is OK 73 e) Edit this remote 74 d) Delete this remote 75 y/e/d> y 76 ``` 77 78 This remote is called `remote` and can now be used like this 79 80 See all buckets 81 82 rclone lsd remote: 83 84 Make a new bucket 85 86 rclone mkdir remote:bucket 87 88 List the contents of a bucket 89 90 rclone ls remote:bucket 91 92 Sync `/home/local/directory` to the remote bucket, deleting any excess 93 files in the bucket. 94 95 rclone sync --interactive /home/local/directory remote:bucket 96 97 ### --fast-list 98 99 This remote supports `--fast-list` which allows you to use fewer 100 transactions in exchange for more memory. See the [rclone 101 docs](/docs/#fast-list) for more details. 102 103 ### Multipart uploads 104 105 rclone supports multipart uploads with QingStor which means that it can 106 upload files bigger than 5 GiB. Note that files uploaded with multipart 107 upload don't have an MD5SUM. 108 109 Note that incomplete multipart uploads older than 24 hours can be 110 removed with `rclone cleanup remote:bucket` just for one bucket 111 `rclone cleanup remote:` for all buckets. QingStor does not ever 112 remove incomplete multipart uploads so it may be necessary to run this 113 from time to time. 114 115 ### Buckets and Zone 116 117 With QingStor you can list buckets (`rclone lsd`) using any zone, 118 but you can only access the content of a bucket from the zone it was 119 created in. If you attempt to access a bucket from the wrong zone, 120 you will get an error, `incorrect zone, the bucket is not in 'XXX' 121 zone`. 122 123 ### Authentication 124 125 There are two ways to supply `rclone` with a set of QingStor 126 credentials. In order of precedence: 127 128 - Directly in the rclone configuration file (as configured by `rclone config`) 129 - set `access_key_id` and `secret_access_key` 130 - Runtime configuration: 131 - set `env_auth` to `true` in the config file 132 - Exporting the following environment variables before running `rclone` 133 - Access Key ID: `QS_ACCESS_KEY_ID` or `QS_ACCESS_KEY` 134 - Secret Access Key: `QS_SECRET_ACCESS_KEY` or `QS_SECRET_KEY` 135 136 ### Restricted filename characters 137 138 The control characters 0x00-0x1F and / are replaced as in the [default 139 restricted characters set](/overview/#restricted-characters). Note 140 that 0x7F is not replaced. 141 142 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 143 as they can't be used in JSON strings. 144 145 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/qingstor/qingstor.go then run make backenddocs" >}} 146 ### Standard options 147 148 Here are the Standard options specific to qingstor (QingCloud Object Storage). 149 150 #### --qingstor-env-auth 151 152 Get QingStor credentials from runtime. 153 154 Only applies if access_key_id and secret_access_key is blank. 155 156 Properties: 157 158 - Config: env_auth 159 - Env Var: RCLONE_QINGSTOR_ENV_AUTH 160 - Type: bool 161 - Default: false 162 - Examples: 163 - "false" 164 - Enter QingStor credentials in the next step. 165 - "true" 166 - Get QingStor credentials from the environment (env vars or IAM). 167 168 #### --qingstor-access-key-id 169 170 QingStor Access Key ID. 171 172 Leave blank for anonymous access or runtime credentials. 173 174 Properties: 175 176 - Config: access_key_id 177 - Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID 178 - Type: string 179 - Required: false 180 181 #### --qingstor-secret-access-key 182 183 QingStor Secret Access Key (password). 184 185 Leave blank for anonymous access or runtime credentials. 186 187 Properties: 188 189 - Config: secret_access_key 190 - Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY 191 - Type: string 192 - Required: false 193 194 #### --qingstor-endpoint 195 196 Enter an endpoint URL to connection QingStor API. 197 198 Leave blank will use the default value "https://qingstor.com:443". 199 200 Properties: 201 202 - Config: endpoint 203 - Env Var: RCLONE_QINGSTOR_ENDPOINT 204 - Type: string 205 - Required: false 206 207 #### --qingstor-zone 208 209 Zone to connect to. 210 211 Default is "pek3a". 212 213 Properties: 214 215 - Config: zone 216 - Env Var: RCLONE_QINGSTOR_ZONE 217 - Type: string 218 - Required: false 219 - Examples: 220 - "pek3a" 221 - The Beijing (China) Three Zone. 222 - Needs location constraint pek3a. 223 - "sh1a" 224 - The Shanghai (China) First Zone. 225 - Needs location constraint sh1a. 226 - "gd2a" 227 - The Guangdong (China) Second Zone. 228 - Needs location constraint gd2a. 229 230 ### Advanced options 231 232 Here are the Advanced options specific to qingstor (QingCloud Object Storage). 233 234 #### --qingstor-connection-retries 235 236 Number of connection retries. 237 238 Properties: 239 240 - Config: connection_retries 241 - Env Var: RCLONE_QINGSTOR_CONNECTION_RETRIES 242 - Type: int 243 - Default: 3 244 245 #### --qingstor-upload-cutoff 246 247 Cutoff for switching to chunked upload. 248 249 Any files larger than this will be uploaded in chunks of chunk_size. 250 The minimum is 0 and the maximum is 5 GiB. 251 252 Properties: 253 254 - Config: upload_cutoff 255 - Env Var: RCLONE_QINGSTOR_UPLOAD_CUTOFF 256 - Type: SizeSuffix 257 - Default: 200Mi 258 259 #### --qingstor-chunk-size 260 261 Chunk size to use for uploading. 262 263 When uploading files larger than upload_cutoff they will be uploaded 264 as multipart uploads using this chunk size. 265 266 Note that "--qingstor-upload-concurrency" chunks of this size are buffered 267 in memory per transfer. 268 269 If you are transferring large files over high-speed links and you have 270 enough memory, then increasing this will speed up the transfers. 271 272 Properties: 273 274 - Config: chunk_size 275 - Env Var: RCLONE_QINGSTOR_CHUNK_SIZE 276 - Type: SizeSuffix 277 - Default: 4Mi 278 279 #### --qingstor-upload-concurrency 280 281 Concurrency for multipart uploads. 282 283 This is the number of chunks of the same file that are uploaded 284 concurrently. 285 286 NB if you set this to > 1 then the checksums of multipart uploads 287 become corrupted (the uploads themselves are not corrupted though). 288 289 If you are uploading small numbers of large files over high-speed links 290 and these uploads do not fully utilize your bandwidth, then increasing 291 this may help to speed up the transfers. 292 293 Properties: 294 295 - Config: upload_concurrency 296 - Env Var: RCLONE_QINGSTOR_UPLOAD_CONCURRENCY 297 - Type: int 298 - Default: 1 299 300 #### --qingstor-encoding 301 302 The encoding for the backend. 303 304 See the [encoding section in the overview](/overview/#encoding) for more info. 305 306 Properties: 307 308 - Config: encoding 309 - Env Var: RCLONE_QINGSTOR_ENCODING 310 - Type: Encoding 311 - Default: Slash,Ctl,InvalidUtf8 312 313 #### --qingstor-description 314 315 Description of the remote 316 317 Properties: 318 319 - Config: description 320 - Env Var: RCLONE_QINGSTOR_DESCRIPTION 321 - Type: string 322 - Required: false 323 324 {{< rem autogenerated options stop >}} 325 326 ## Limitations 327 328 `rclone about` is not supported by the qingstor backend. Backends without 329 this capability cannot determine free space for an rclone mount or 330 use policy `mfs` (most free space) as a member of an rclone union 331 remote. 332 333 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 334