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