Docs
api
Object-based Storage(US3)
UpdateUdsRule

Update decompression rules - UpdateUdsRule

Overview

Automatically trigger decompression for files in object storage (US3).

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateUdsRule.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RuleIdstringThe unique Id of the ruleYes
RuleNamestringRule NameYes
SrcBucketstringSource Bucket name, globally uniqueYes
SrcTokenIdstringOne of the tokens’ tokenId from the source bucketYes
DstBucketstringTarget Bucket name, globally uniqueYes
DstTokenIdstringOne of the target bucket’s tokenIdsYes
DstDirectorystringDestination directory after decompressionYes
KeepUS3NamebooleanWhether to use the prefix of the compressed file as the last directory layerYes
PrefixesstringPrefix to trigger decompressionYes
Ops.NstringThe ops array of operations, “Ops.0”:“unzip” """.No
Events.NstringArray of notification eventsNo
ContactGroupIdstringContacted User Group IDNo
NotificationTypes.NstringArray of notification typesNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
RuleIdstringReturn the rule’s rule IDYes
MesagestringDescription of the success or failure of the request messageNo

Example

Request Example

https://api.dezai.com/?Action=UpdateUdsRule
&RuleId="RuleId"
&RuleName="name"
&SrcBucketName="SrcBucketName"
&SrcTokenId="SrcTokenId"
&DstBucketName=“DstBucketName”
&DstTokenId="DstTokenId"
&DstDirectory="KeepUS3Name"
&KeepUS3Name=false
&Prefixes="Prefixes"
&Ops.n="Ops.0"
&Events.n="Events.0"
&ContactGroupId="ContactGroupId"
&NotificationTypes.n="NotificationTypes.0"
&RuleName="RuleName"

Response Example

{
  "Action": "UpdateUdsRuleResponse",
  "Mesage": "fElcUBax",
  "RetCode": 0,
  "RuleId": "RuleId"
}