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