tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    Hash Calculation

    Last updated: 2024-02-02 15:51:37
    Download PDF

      Overview

      This document provides an overview of APIs and SDK code samples for hash calculation in CI.
      API
      Description
      Uses a sync request to perform hash calculation and return a calculated hash value in real time.
      Submits a hash calculation job.
      Queries the result of a specified hash calculation job.

      Sync Request for Hash Calculation

      Feature description

      This API uses a sync request to perform hash calculation and return a calculated hash value.

      Method prototype

      func (s *CIService) GetFileHash(ctx context.Context, name string, opt *GetFileHashOptions) (*GetFileHashResult, *Response, error)

      Sample request

      opt := &cos.GetFileHashOptions{
          CIProcess: "filehash",
          Type:      "md5",
      }
      res, _, err := c.CI.GetFileHash(context.Background(), "test.jpg", opt)

      Parameter description

      type GetFileHashOptions struct {
          CIProcess   string
          Type        string
          AddToHeader bool
      }
      Parameter
      Description
      Type
      Required
      name
      Full path of the file to be operated
      String
      Yes
      CIProcess
      Operation type. It is fixed at filehash for hash calculation.
      String
      Yes
      Type
      Supported hash algorithm. Valid values: md5, sha1, sha256
      String
      Yes
      AddToHeader
      Whether to automatically add the calculated hash value to the custom header in the file. Format: x-cos-meta-md5/sha1/sha256. Valid values: true, false. If this parameter is left empty, it is false by default.
      Bool
      No

      Response description

      type GetFileHashResult struct {
          FileHashCodeResult *FileHashCodeResult
          Input              *FileProcessInput
      }
      Parameter
      Description
      Type
      FileHashCodeResult
      Hash calculation result. For more information, see FileProcessJobOptions.Input.
      Container
      Input
      Basic information of the input file. For more information, see FileProcessJobOptions.Operation.FileHashCodeResult.
      Container

      Submitting a Hash Calculation Job

      Feature description

      This API is used to submit a job to perform hash calculation and asynchronously return a calculated hash value.

      Method prototype

      func (s *CIService) CreateFileProcessJob(ctx context.Context, opt *FileProcessJobOptions) (*FileProcessJobResult, *Response, error)

      Sample request

      createJobOpt := &cos.FileProcessJobOptions{
          Tag: "FileHashCode",
          Input: &cos.FileProcessInput{
              Object: "294028.zip",
          },
          Operation: &cos.FileProcessJobOperation{
              FileHashCodeConfig: &cos.FileHashCodeConfig{
                  Type:        "sha1",
                  AddToHeader: true,
              },
          },
          QueueId: "p111a8dd208104ce3b11c78398f658ca8",
      }
      res, _, err := c.CI.CreateFileProcessJob(context.Background(), createJobOpt)

      Parameter description

      type FileProcessJobOptions struct {
          XMLName          xml.Name
          Tag              string
          Input            *FileProcessInput
          Operation        *FileProcessJobOperation
          QueueId          string
          CallBackFormat   string
          CallBackType     string
          CallBack         string
          CallBackMqConfig *NotifyConfigCallBackMqConfig
      }
      type FileProcessInput struct {
          Region     string
          Bucket     string
          Object           string
      }
      type FileProcessJobOperation struct {
          FileHashCodeConfig   *FileHashCodeConfig
          FileHashCodeResult   *FileHashCodeResult
          FileUncompressConfig *FileUncompressConfig
          FileUncompressResult *FileUncompressResult
          FileCompressConfig   *FileCompressConfig
          FileCompressResult   *FileCompressResult
          Output               *FileProcessOutput
          UserData             string
      }
      type FileHashCodeConfig struct {
          Type        string
          AddToHeader bool
      }
      type FileHashCodeResult struct {
          MD5          string
          SHA1         string
          SHA256       string
          FileSize     int
          LastModified string
          Etag         string
      }
      type FileUncompressConfig struct {
          Prefix         string
          PrefixReplaced string
      }
      type FileUncompressResult struct {
          Region    string
          Bucket    string
          FileCount string
      }
      type FileCompressConfig struct {
          Flatten string
          Format  string
          UrlList string
          Prefix  string
          Key     string
      }
      type FileCompressResult struct {
          Region     string
          Bucket     string
          Object           string
      }
      type FileProcessOutput struct {
          Region     string
          Bucket     string
          Object           string
      }
      type NotifyConfigCallBackMqConfig struct {
          MqMode   string
          MqRegion string
          MqName   string
      }
      Parameter
      Description
      Type
      Required
      Tag
      Job tag, which currently can only be FileHashCode.
      String
      Yes
      Input
      The object to be processed. For more information, see Input.
      Container
      Yes
      Operation
      Operation rule
      Container
      Yes
      Operation.FileHashCodeConfig
      Hash calculation rule. For more information, see Submitting Hash Calculation Job.
      Container
      Yes
      Operation.FileHashCodeResult
      The calculated hash value, which will not be returned when the job is not completed. For more information, see Submitting Hash Calculation Job.
      Container
      No
      Operation.UserData
      The user information passed through, which is printable ASCII codes of up to 1,024 in length.
      String
      No
      QueueId
      ID of the queue where the job is in
      String
      Yes
      CallBackFormat
      Job callback format, which can be JSON or XML (default). It takes priority over that of the queue.
      String
      No
      CallBackType
      Job callback type, which can be Url (default) or TDMQ. It takes priority over that of the queue.
      String
      No
      CallBack
      Job callback address. It takes higher priority over that of the queue.
      String
      No
      CallBackMqConfig
      TDMQ configuration for job callback as described in Structure, which is required if CallBackType is TDMQ.
      Container
      No

      Response description

      type FileProcessJobResult struct {
          JobsDetail FileProcessJobResult
      }
      type FileProcessJobResult struct {
          Code         string
          Message      string
          JobId        string
          Tag          string
          State        string
          CreationTime string
          StartTime    string
          EndTime      string
          QueueId      string
          Input        *FileProcessInput
          Operation    *FileProcessJobOperation
      }
      Parameter
      Description
      Type
      JobsDetail
      Job details
      Container
      Code
      Error code, which will be returned only if State is Failed.
      String
      Message
      Error message, which will be returned only if State is Failed.
      String
      JobId
      Job ID
      String
      Tag
      Job tag: FileHashCode
      String
      State
      Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel.
      String
      CreationTime
      Job creation time
      String
      StartTime
      Job start time
      String
      EndTime
      Job end time
      String
      QueueId
      ID of the queue which the job is in
      String
      Input
      Path of the input file for this job. For more information, see FileProcessJobOptions.Input.
      Container
      Operation
      Operation rule. For more information, see FileProcessJobOptions.Operation.
      Container

      Querying Hash Calculation Result

      Feature description

      This API is used to query the details of a file processing job by job ID.

      Method prototype

      func (s *CIService) DescribeFileProcessJob(ctx context.Context, jobid string) (*FileProcessJobResult, *Response, error)

      Sample request

      jobid := "<jobid>"
      res, _, err := c.CI.DescribeFileProcessJob(context.Background(), jobid)

      Parameter description

      Parameter
      Description
      Type
      jobid
      File processing job ID
      String

      Response description

      type FileProcessJobResult struct {
          JobsDetail *FileProcessJobsDetail
      }
      Parameter
      Description
      Type
      Required
      JobsDetail
      Job details, which is the same as Response.JobsDetail in the CreateFileProcessJob API.
      Container
      Yes
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy