Docs
api
Object-based Storage(US3)
DescribeUFileLifeCycle

Obtain Lifecycle Information - DescribeUFileLifeCycle

Overview

Obtain Lifecycle Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUFileLifeCycle.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
BucketNamestringStorage Space NameYes
LifeCycleIdstringLifecycle Id; If this parameter is not passed, all lifecycle information under the storage space will be pulled.No

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
DateSetarray[LifeCycleItem]Lifecycle InformationYes

Data Model

LifeCycleItem

Field NameTypeDescription InformationRequired
LifeCycleIdstringLifecycle IdNo
LifeCycleNamestringLifecycle NameNo
PrefixstringPrefix applicable to the lifecycle; * for all files in the storage space;No
DaysintSpecify an expiration day N, the file will expire and be automatically deleted N days after its most recent update time, 0 represents not enabled;No
StatusstringEnabled -- Enabled, Disabled -- Not enabledNo
BucketNamestringStorage Space NameNo
ArchivalDaysintSpecify an expiration day N, the file will expire N days after its most recent update time, and automatically convert to archive storage type, 0 means not enabled;No
IADaysintSpecify an expiration day N, the file will expire N days after its most recent update time, and automatically convert to the low-frequency storage type, 0 means not enabled;No

Example

Request Example

https://api.ucloud-global.com/?Action=DescribeUFileLifeCycle
&Region=cn-gd
&ProjectId=org-sdfsdf
&BucketName=test
&LifeCycleId=dc7eca04-edbc-4ae9-aefd-816253123456

Response Example

{
  "Action": "DescribeUFileLifeCycleResponse",
  "DateSet": [
    {
      "BucketName": "test",
      "Days": 10,
      "LifeCycleId": "dc7eca04-edbc-4ae9-aefd-816253123456",
      "LifeCycleName": "lifecycle",
      "Prefix": "test-",
      "Status": "Enabled"
    }
  ],
  "RetCode": 0
}