Decompression

This API is used to perform decompression operations on compressed files within the cloud storage platform. After decompression is complete, the system automatically generates a list file in cloud storage, which contains information about the decompressed files. To use this interface, users must have the wos:ProcessMedia permission and putObject permission for the target file. If you configure the task to delete the source file after decompression, you will also need the deleteObject permission.

Create a Decompression Task

Request Syntax

POST /key?decompression HTTP/1.1      
Host: Bucket.Endpoint
Date: Date
Authorization: Authorization

<?xml version="1.0" encoding="utf-8"?>
<Decompression xmlns="http://wcs.chinanetcenter.com/document">   
  <Config>
    <Param>
      <format>string</format>
      <bucket>string</bucket>
      ...
    </Param>
    <Output>
      <OutputBucket>string</OutputBucket>
      <OutputKey>string</OutputKey>
    </Output>
  </Config>
  <NotifyURL>string</NotifyURL>
  <Force>int</Force>
</Decompression>

Request Parameters

None.

Request Headers

Only Common Request Headers are required.

Request Body

The request body should contain XML data as follows:

Response Syntax

On success, the response will be:

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
Date: date
Server: WS-web-server

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DecompressionResult xmlns="http://wcs.chinanetcenter.com/document">
  <Succeed>
    <PersistentId>string</PersistentId>
  </Succeed>
</DecompressionResult>

Response Headers

Only Common Response Headers are used.

Response Elements

Example

POST /test.zip?decompression HTTP/1.1
Host: Bucket.Endpoint
Date: Date
Authorization: Authorization

<?xml version="1.0" encoding="utf-8"?>
<Decompression xmlns="http://wcs.chinanetcenter.com/document">
  <Config>
    <Param>
      <format>zip</format>
      <crush>0</crush>
    </Param>
    <Output>
      <OutputBucket>excite</OutputBucket>
      <OutputKey>test.list</OutputKey>
    </Output>
  </Config>
</Decompression>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
Date: date
Server: WS-web-server

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DecompressionResult xmlns="http://wcs.chinanetcenter.com/document">
  <Succeed>
    <PersistentId>20500a49659******e088b1f736aa2a4</PersistentId>
  </Succeed>
</DecompressionResult>

Query Decompression Task Status

This API allows you to query the status of a decompression persistent task in cloud storage. The wos:GetProcessMediaStatus permission is required.

Request Syntax

GET /?decompression&persistentId=<persistentId>
Host: Bucket.Endpoint
Date: Date
Authorization: Authorization

Request Parameters

Request Headers

Only Common Request Headers are required.

Request Body

None.

Response Syntax

HTTP/1.1 StatusCode
Date: Date
Content-Type: type
Content-Length: length
Server: WS-web-server

<?xml version="1.0" encoding="utf-8"?>
<QueryDecompressionResult xmlns="https://wcs.chinanetcenter.com/document">
  <Id>string</Id>
  <CreationTime>string</CreationTime>
  <Input>
    <Bucket>string</Bucket>
    <Key>string</Key>
    <Size>int</Size>
  </Input>
  <Item>
    <Cmd>string</Cmd>
    <Code>int</Code>
    <Desc>string</Desc>
    <CostTime>int</CostTime>
    <Error>string</Error>
    <Output>
      <OutputBucket>string</OutputBucket>
      <OutputKey>string</OutputKey>
      <Size>int</Size>
    </Output>
  </Item>
</QueryDecompressionResult>

Response Headers

Only Common Response Headers are used.

Example

Request Example:
GET /?decompression&persistentId=20500a496******b1f736aa2a4
Host: Bucket.Endpoint
Date: Date
Authorization: Authorization

Response Example
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
Date: date
Server: WS-web-server

<?xml version="1.0" encoding="utf-8"?>
<QueryDecompressionResult xmlns="https://wcs.chinanetcenter.com/document">
  <Id>20500a496******b1f736aa2a4</Id>
  <CreationTime>2019-05-16T03:16:05Z</CreationTime>
  <Input>
    <Bucket>sweet</Bucket>
    <Key>happy%2Ftest.zip</Key>
    <Size>1000</Size>
  </Input>
  <Item>
    <Cmd>decompression/zip</Cmd>
    <Code>3</Code>
    <CostTime>0</CostTime>
    <Desc>finish</Desc>
    <Error>null</Error>
    <Output>
      <OutputBucket>excite</OutputBucket>
      <OutputKey>test.list</OutputKey>
      <Size>2000</Size>
    </Output>
  </Item>
</QueryDecompressionResult>

Decompression Notification Data Description

Notification data is formatted as follows:

<?xml version="1.0" encoding="utf-8"?>
<NotifyBody xmlns="https://wcs.chinanetcenter.com/document">
  <Id>string</Id>
  <CreatTime>string</CreatTime>
  <Input>
    <Bucket>string</Bucket>
    <Key>string</Key>
    <Size>int</Size>
  </Input>
  <Item>
    <Cmd>string</Cmd>
    <Code>int</Code>
    <Desc>string</Desc>
    <CostTime>int</CostTime>
    <Error>string</Error>
    <Output>
      <OutputBucket>string</OutputBucket>
      <OutputKey>string</OutputKey>
      <Size>int</Size>
      <Hash>string</Hash>
    </Output>
  </Item>
</NotifyBody>

Parameter Description

Decompression Parameter Details

Note: If you need to delete the source file, you must have deleteObject permission.