OSSUtil

ossutil is a user friendly command line tool to upload data to the Quartet Data Portal. It supports the following operating systems: Windows, Linux, and macOS. You can download and install the ossutil version that best suits your requirements.

Name	Recommendation	Notice	Category	Characteristics	Expected Average Speed
OSSUtil	High	Recommend to use it on a Linux server with wired network	Terminal Tool	Fast, Powerful and Supporting resuming from a breakpoint	40-100MB/s

Click here to download ossutil.
Click here to see more details in ossutil.

Here is an example that install ossutil on Linux.

1. Download the ossutil installation package¶

wget http://gosspublic.alicdn.com/ossutil/1.7.6/ossutil64

2. Modify the execution permissions of the file¶

chmod 755 ossutil64

3. Generate a configuration file in interactive mode¶

a. Run the following command:

./ossutil64 config

b. Configure the path of the configuration file as prompted.

Note

We recommend that you use the default path for the configuration file by pressing the Enter key. Enter the name of the configuration file. The file name can contain a path. The default path is /home/user/.ossutilconfig. If you press the Enter key without specifying a different name, the file is generated in the default path. If you want to generate the file in another path, set the --config-file configuration item to the path that you want to use.

c. Set the language of ossutil as prompted.

Note

Enter the language: CH or EN. The default language is CH. The configuration of this parameter takes effect after the config command is run.

d. Configure the parameters, including Endpoint, AccessKey ID, AccessKey secret, and Security Token Service (STS) token as prompted.

The endpoint is http://oss-cn-shanghai.aliyuncs.com.

The AccessKeyId (accessKey), AccessKeySecret (accessSecret), STS Token (stsToken) are from data.json which is generated by clicking "New Token" button in Quartet Data portal website.

The contents of the data.json file are as follows:

{
    "uploadPath": "oss://quartet-data-portal/data/your@email.address/transcriptomics/",
    "region": "oss-cn-shanghai",
    "durationHours": 12,
    "expiration": "Thu Sep 23 2021 22:02:21 GMT+0800",
    "accessKey": "STS.NSw4TPayxZcbeXQbDfoZiHE16",
    "accessSecret": "38DvQmDt7o7jkrtGXEakjXJMXvoAhYF4cKsGJUaX9Lhz",
    "stsToken": "CAIS2wR1q6Ft5B2yfSjIr5DCf+7kjKZZ7aGJZ37ghkQzY9VFp4Ca1Dz2IHlJdXFgBOEdsf4wlWFR7/wdlrxKVpZfWUHYQcJs56xQ6x+oZ7DGv8HtHWi3dzTiSwapEBfe8JL4kI6bJYqv2J7PBnnAkihsu5uYERypQ12iN7CQlJdjda55dwKkbD1Ado80Qwx5s501OGf2P/SgOQKI523LFxhQpxZbg2Fy4rjdusqH8UjygVn31uIyrYb8KYTecKsKBppkVMqv1+Fbb7fI1DUqiyJH76BrlqdJiwSlj9iWGAtW+A7UcbiWoMRyJRVla7R/F6dYpb3kkudks+iUm43rwlFcIOxMUi3ZS5unxsTsFv6lP9B/eLrmfX/LleqpH67pvhg4Jm4BPQVRcMAgMmN3DB0nUXaYWA/Omj3jZgOkVNLEssUf2oZ0yFPF5MeDI0P1LZySzScfPO1FDSQvLAVE+W36bogMcQFHb0gdUtTzd4hoaw1Eoq7FpBDbUjYarktapPrjffjbyOl9Hoz0RcBBypFPJsYE4XI3Rk7rRq7rhk4IfSl9RqxK2a2XBP3d06OfweOcRe/FB4plvU5BIwjLoiSMWQEDT3z978EqLkuF9t3QxarD6JRmHyMg+9xWC0eIfcsrpFoh2Y2b2Aie6/OkTmqj+HEz4NjA445K6EB/ObWG+7bK52CF4CbIPvlowJaPBTVVLE7pKyAj8pe7nWkaoh0NqWawNisE5k6ZvWTKJ5RGg6TbmyIfXf0MyLWBEm3/5Bh5FNuT/7sXVep+dfhJSOq12RtuwvD3PaENd1wiPn4agAEagz7gU9EpH9fkAUugKbeH9H8ph22NrWAu8WUQF5PPi9CnqP1itUkdDtaTTprv4E5zD3RyWiYH9yA5jn9pYjwvj1tSBXjOCrIo/MLx0DGVSTZ6yExb+SYPNKzaWQ1rloPtKqGWOcXNCOgvYiy8U21Hw8UVzO7EErVAuPvlDNdqWg==",
    "authorizedCode": "eyJpZCI6IlNUUy5OU3c0VFBheXhaY2JlWFFiRGZvWmlIRTE2Iiwic2VjcmV0IjoiMzhEdlFtRHQ3bzdqa3J0R1hFYWtqWEpNWHZvQWhZRjRjS3NHSlVhWDlMaHoiLCJzdG9rZW4iOiJDQUlTMndSMXE2RnQ1QjJ5ZlNqSXI1RENmKzdraktaWjdhR0paMzdnaGtRelk5VkZwNENhMUR6MklIbEpkWEZnQk9FZHNmNHdsV0ZSN1wvd2RscnhLVnBaZldVSFlRY0pzNTZ4UTZ4K29aN0RHdjhIdEhXaTNkelRpU3dhcEVCZmU4Skw0a0k2YkpZcXYySjdQQm5uQWtpaHN1NXVZRVJ5cFExMmlON0NRbEpkamRhNTVkd0trYkQxQWRvODBRd3g1czUwMU9HZjJQXC9TZ09RS0k1MjNMRnhoUXB4WmJnMkZ5NHJqZHVzcUg4VWp5Z1ZuMzF1SXlyWWI4S1lUZWNLc0tCcHBrVk1xdjErRmJiN2ZJMURVcWl5Skg3NkJybHFkSml3U2xqOWlXR0F0VytBN1VjYmlXb01SeUpSVmxhN1JcL0Y2ZFlwYjNra3Vka3MraVVtNDNyd2xGY0lPeE1VaTNaUzV1bnhzVHNGdjZsUDlCXC9lTHJtZlhcL0xsZXFwSDY3cHZoZzRKbTRCUFFWUmNNQWdNbU4zREIwblVYYVlXQVwvT21qM2paZ09rVk5MRXNzVWYyb1oweUZQRjVNZURJMFAxTFp5U3pTY2ZQTzFGRFNRdkxBVkUrVzM2Ym9nTWNRRkhiMGdkVXRUemQ0aG9hdzFFb3E3RnBCRGJVallhcmt0YXBQcmpmZmpieU9sOUhvejBSY0JCeXBGUEpzWUU0WEkzUms3clJxN3JoazRJZlNsOVJxeEsyYTJYQlAzZDA2T2Z3ZU9jUmVcL0ZCNHBsdlU1Qkl3akxvaVNNV1FFRFQzejk3OEVxTGt1Rjl0M1F4YXJENkpSbUh5TWcrOXhXQzBlSWZjc3JwRm9oMlkyYjJBaWU2XC9Pa1RtcWorSEV6NE5qQTQ0NUs2RUJcL09iV0crN2JLNTJDRjRDYklQdmxvd0phUEJUVlZMRTdwS3lBajhwZTduV2thb2gwTnFXYXdOaXNFNWs2WnZXVEtKNVJHZzZUYm15SWZYZjBNeUxXQkVtM1wvNUJoNUZOdVRcLzdzWFZlcCtkZmhKU09xMTJSdHV3dkQzUGFFTmQxd2lQbjRhZ0FFYWd6N2dVOUVwSDlma0FVdWdLYmVIOUg4cGgyMk5yV0F1OFdVUUY1UFBpOUNucVAxaXRVa2REdGFUVHBydjRFNXpEM1J5V2lZSDl5QTVqbjlwWWp3dmoxdFNCWGpPQ3JJb1wvTUx4MERHVlNUWjZ5RXhiK1NZUE5LemFXUTFybG9QdEtxR1dPY1hOQ09ndllpeThVMjFIdzhVVnpPN0VFclZBdVB2bEROZHFXZz09IiwicHJpdmlsZWdlIjoiUmVhZC1Xcml0ZSIsImV4cGlyYXRpb24iOiIyMDIxLTA5LTIzVDE0OjAyOjIxWiIsIm9zc3BhdGgiOiJvc3M6XC9cL3F1YXJ0ZXQtZGF0YS1wb3J0YWxcL2RhdGFcL3l1ZXFpYW5nc29uZ0BmdWRhbi5lZHUuY25cL1JOQV90ZXN0XC90cmFuc2NyaXB0b21pY3NcLyIsInJlZ2lvbiI6Im9zcy1jbi1zaGFuZ2hhaSIsImR1cmF0aW9uX3NlY29uZHMiOjQzMjAwfQ=="
}

The parameters are as prompted:

Please enter endpoint: http://{region}.aliyuncs.com, such as http://oss-cn-shanghai.aliyuncs.com
Please enter accessKeyID: {accessKey}, such as STS.NSw4TPayxZcbeXQbDfoZiHE16
Please enter accessKeySecret: {accessSecret}, such as 38DvQmDt7o7jkrtGXEakjXJMXvoAhYF4cKsGJUaX9Lhz
Please enter stsToken: {stsToken}, such as CAIS2wR1q6Ft5B2yfSjIr5DCf....

4. Upload files¶

Run the cp command to upload local files or directories to Object Storage Service (OSS).

Click here to see more details in cp.
You can verify and confirm uploaded files by clicking "Check" button in Quartet Data portal website.
You only have 12 duration hours, please upload as soon as possible (But don't worry, when you started the uploading, the process will not be interrupted until finished or killed by you).

./ossutil64 cp -r your_directory oss://quartet-data-portal/data/your@email.address/transcriptomics/

Last update: 2024-10-14