tencent cloud


Request Signature

Last updated: 2024-01-31 16:54:06
    CI uses signatures to verify the validity of requests. The developer authorizes a signature to the client for it to upload, download, and manage the specified resources.
    When using CI, you can call RESTful APIs to initiate anonymous or signed HTTP requests. For signed requests, the server will validate the identity of the requester.
    Anonymous request: an HTTP request that does not carry any authentication information, and is sent using RESTful APIs.
    Signed request: an HTTP request that carries a signature. The server will authenticate requesters and only execute requests initiated by authenticated ones. If the authentication fails, the server will return an error message and deny the request.
    CI uses the same signature algorithm as Cloud Object Storage (COS) and uses Hash-based message authentication code (HMAC) custom solutions for identity verification.

    Signature algorithm

    Currently, CI has integrated with COS, meaning that you can use a COS domain to process images. The signature version required is different for CI and COS domains.
    CI domain: formatted as <BucketName-APPID>.<picture region>.myqcloud.com/<picture name> (for example, examplebucket-1250000000.picsh.myqcloud.com/picture.jpeg). It uses JSON signatures.
    COS domain: formatted as <BucketName-APPID>.cos.<Region>.myqcloud.com (for example, examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/picture.jpeg). It uses XML signatures. For more information about XML signatures, please see Request Signature.

    Signature scenarios

    Applicable Signature
    Processing data upon download
    Hotlink protection not enabled
    No signature verification
    Hotlink protection enabled
    Signature verification
    Processing data upon upload
    Persistent processing
    XML signatures
    Bucket API calls
    Query, activation, deletion, etc.
    XML signatures
    Content recognition
    Detecting pornographic, political, or violent/terror content
    XML signatures

    Signature tools

    To generate a signature, you need the APPID (e.g., 1250000000), bucket name (e.g., examplebucket-ci), as well as the SecretID and SecretKey of the project.
    The following describes how to obtain the information above:
    1. Log in to the CI console and click Bucket Management on the left sidebar.
    2. Click the name of the desired bucket.
    3. Click Bucket Configuration to view the bucket name and bucket ID. If there is no bucket created for the current project, you can create one by referring to Creating Buckets.
    4. Log in to the CAM console and go to Manage API Key to get SecretID and SecretKey.
    The signature calculation process of CI is the same as that of COS. You can use a COS signature tool to generate a signature version you need according to the signature scenario.

    Using a signature

    Signed HTTP requests sent via RESTful APIs can pass the signature in the following ways:
    1. Pass through a standard HTTP Authorization header, such as Authorization: q-sign-algorithm=sha1&q-ak=...&q-sign-time=1557989753;1557996953&...&q-signature=...
    2. Pass as an HTTP request parameter (be sure to URL-encode), such as /exampleobject?q-sign-algorithm=sha1&q-ak=...&q-sign-time=1557989753%3B1557996953&...&q-signature=...
    In the example above, ... are the signatures.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support