Obtain Lifecycle Information - DescribeUFileLifeCycle
Overview
Obtain Lifecycle Information
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeUFileLifeCycle . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | No |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
BucketName | string | Storage Space Name | Yes |
LifeCycleId | string | Lifecycle Id; If this parameter is not passed, all lifecycle information under the storage space will be pulled. | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
DateSet | array[LifeCycleItem] | Lifecycle Information | Yes |
Data Model
LifeCycleItem
Field Name | Type | Description Information | Required |
---|---|---|---|
LifeCycleId | string | Lifecycle Id | No |
LifeCycleName | string | Lifecycle Name | No |
Prefix | string | Prefix applicable to the lifecycle; * for all files in the storage space; | No |
Days | int | Specify 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 |
Status | string | Enabled -- Enabled, Disabled -- Not enabled | No |
BucketName | string | Storage Space Name | No |
ArchivalDays | int | Specify 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 |
IADays | int | Specify 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
}