Feature Overview
The COS Signature Tool is a web-based utility provided by Tencent Cloud Object Storage (COS) for generating request signatures. By entering specified parameters on the page to create and validate request signatures for accuracy.
COS supports two API versions: XML and JSON, with differences in signature parameters. COS recommends using the XML version. JSON API is an earlier version provided for users to access COS before the XML API was introduced.JSON and XML APIs operate the same core of infrastructure and enable cross-format data, but their interface specifications are incompatible
For information on the XML version's signature documentation, please see the XML version Request Signature. For information on the JSON version's signature documentation, please see the JSON version Signature Algorithm. Supports and Limits
The signature tool does not recognize or prompt any incorrect parameters. When compare the created signature with results from SDK or other tools, it won't auto-correct any mistakes in your entered parameters.
Signature tool will identify invalid parameters and provide corresponding prompts. However, it may still generate signature that fail verification
Signature tool is disabled until all the mandatory parameters are filled.The system automatically checks for complete field entries before processing.
Tool URL
How to Use
XML Version Signature Tool
Enter Basic Configuration
2. In the Basic Information section:
Signature type: Select XML API signature.
Signature Validity Period: You can click Obtain (valid for 60 minutes) to get a signature with a validity period of 60 minutes or you can customize start and end time to reproduce the signature result within that time frame. For more information on signature validity periods, please see Request Signature. Note:
All parameters in the Basic Information section are required.
Enter API Key Information
In the API Key section, enter your API key credentials.
Note:
All the information in the API key section is required.
For API key parameter information, use sub-account keys and authorize following the principle of least privilege to reduce risks. Obtain sub-account keys, please refer to Sub-account Access Key Management. Ensure all information is entered accurately. Incorrect entries will invalidate your signature.
Enter HTTP Parameters
In the HTTP Parameters section, enter the relevant parameters. The main parameters are as follows:
HttpMethod: Required. The HTTP request method, including GET, POST, PUT, DELETE, HEAD.
HttpURI: Required. The HTTP request URI, specifying your target object name.
HttpParameters: Optional. HTTP request parameters are used for validate URL parameters. The key must be in lowercase, and the value must be URLEncoded. Multiple keys should be sorted alphabetically.
For example, "prefix=abc" represents specifies objects with prefix "abc".
HttpHeaders: Optional. HTTP request headers. This parameter is used for validate URL parameters. The key must be in lowercase, and the value must be URLEncoded. Multiple keys should be sorted alphabetically.
For example, Host:bucket1-1254000000.cos.ap-beijing.myqcloud.com indicates access to specified files in the bucket "bucket1" under account 1254000000, and the corresponding HttpHeaders are host=bucket1-1254000000.cos.ap-beijing.myqcloud.com.
Generate Signature and Review Process Parameters
Click Generate Signature to view the result in the Result Feedback on the right.
The COS Signature Tool will display both the final generated signature and all parameters used during the signature process. For more information related process parameters, please refer to Request Signature. JSON Version Signature Tool
Enter Basic Configuration Information
2. In the Basic Information section, enter the signature type, bucket name, and current time.
Signature Type: Select JSON API Signature.
Bucket Name: Enter the name of the bucket you wish to access, in the format bucketname-appid.
Current Time: The present system time, which is a value conforming to the Unix Epoch timestamp specification, measured in seconds. You can also enter a specific time to reproduce the signature results under the specified timestamp.
Note:
All parameters in the Basic Information section are required.
Enter API Key Information
In the API Key section, enter your API key credentials.
Note:
It is recommended to use sub-account keys and follow the principle of least privilege to reduce risks. For information on obtaining sub-account keys, please see Sub-account Access Key Management. The API key information is a required field; ensure all information is entered accurately. Incorrect entries will invalidate your signature.
Enter HTTP Parameters
In the HTTP Parameters section, enter the relevant parameters. The main parameters are as follows:
ExpiredTime: Required. The signature's expiration time in seconds. You can add a valid duration to the current time parameter to obtain the expiration time of the signature. For a single signature, the expiration time must be set to 0.
RandomId: Required. A random string of unsigned decimal integers.
FilePath: Optional. Indicates the relative path of the storage resource. The format is as follows: /[dirname]/[filename].
If the operated object is a folder, leave the filename with the default value. When specifying filename should include the file extension.
If the FilePath is empty, the generated request signature can be used to access all objects in the bucket.
For a detailed description of the related HTTP request parameters, please see Signature Algorithm. Generate Signature and Review Process Parameters
Click Generate Signature to view the result in the Result Feedback on the right.
The COS Signature Tool will display the final signature and all parameters used during the signature process. For more information related process parameters, please refer to the Signature Algorithm.