Obtaining the Lifecycle Rules of a Bucket (SDK for Node.js)

If you have any questions during development, post them on the Issues page of GitHub.

Function

You can configure lifecycle rules to periodically delete objects or transition objects between storage classes. For more information, see Lifecycle Management.

This API returns the lifecycle rules of a bucket.

Restrictions

To obtain the lifecycle rules of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetLifecycleConfiguration in IAM or GetLifecycleConfiguration in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
To learn about the mappings between OBS regions and endpoints, see Regions and Endpoints.

Method

ObsClient.getBucketLifecycle(params)

Request Parameters

**Table 1** BucketRequestInput
Parameter	Type	Mandatory (Yes/No)	Description
Bucket	string	Yes	Explanation: Bucket name. Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets with the same name in the same region, no error will be reported, and the bucket attributes comply with those set in the first creation request. Value range: The value can contain 3 to 63 characters. Default value: None

Responses

**Table 2** Responses
Type	Description
Table 3 NOTE: This API returns a Promise response, which requires the Promise or async/await syntax.	Explanation: Returned results. For details, see Table 3.

**Table 3** Response
Parameter	Type	Description
CommonMsg	ICommonMsg	Explanation: Common information generated after an API call is complete, including the HTTP status code and error code. For details, see Table 4.
InterfaceResult	Table 5	Explanation: Results outputted for a successful call. For details, see Table 5. Restrictions: This parameter is not included if the value of Status is greater than 300.

**Table 4** ICommonMsg
Parameter	Type	Description
Status	number	Explanation: HTTP status code returned by the OBS server. Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For details, see Status Codes.
Code	string	Explanation: Error code returned by the OBS server.
Message	string	Explanation: Error description returned by the OBS server.
HostId	string	Explanation: Request server ID returned by the OBS server.
RequestId	string	Explanation: Request ID returned by the OBS server.
Id2	string	Explanation: Request ID2 returned by the OBS server.
Indicator	string	Explanation: Error code details returned by the OBS server.

**Table 5** GetBucketLifecycleOutput
Parameter	Type	Description
RequestId	string	Explanation: Request ID returned by the OBS server Default value: None
Rules	LifecycleRule[]	Yes Explanation: Lifecycle rule information. For details, see Table 6.

**Table 6** LifecycleRule
Parameter	Type	Description
ID	string	Explanation: Lifecycle rule ID.
Prefix	string	Explanation: Object name prefix. It identifies the objects the rule applies to. You can leave this parameter blank to apply the rule to all objects in the bucket. Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you set Prefix to ExampleObject.jpg, the rule applies to object ExampleObject.jpg alone. If you set Prefix to logs/, the rule applies to objects logs/day1, logs/day2, and logs/day3. If you leave Prefix blank, the rule applies to all objects in the bucket.
Status	string	Explanation: Whether the rule is enabled. Value range: Enabled Disabled
Transitions	Transition[]	Explanation: Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 7. Restrictions: This parameter is only available for the latest object version.
Expiration	Expiration	Explanation: Object expiration time. For details, see Table 8. Restrictions: This parameter is only available for the latest object version.
NoncurrentVersionTransitions	NoncurrentVersionTransition[]	Explanation: Policies for storage class transition, including transition time and the storage class after transition. For details, see Table 9. Restrictions: This parameter is only available for historical object versions. Versioning must be enabled (or suspended after being enabled) for the bucket.
NoncurrentVersionExpiration	NoncurrentVersionExpiration	Explanation: Expiration time of historical object versions. For details, see Table 10. Restrictions: This parameter is only available for historical object versions. Versioning must be enabled (or suspended after being enabled) for the bucket. This parameter is not available for parallel file systems.

**Table 7** Transition
Parameter	Type	Description
StorageClass	StorageClassType	Explanation: Storage class of the object after transition
Date	string	Explanation: OBS executes the lifecycle rule for objects that were modified before the specified date.
Days	number	Explanation: How many days can pass since the last update before the lifecycle rule takes effect

**Table 8** Expiration
Parameter	Type	Description
Date	string	Explanation: OBS executes the lifecycle rule (deletion) for objects that were modified before the specified date.
Days	number	Explanation: How many days can pass since the last update before the lifecycle rule (deletion) takes effect

**Table 9** NoncurrentVersionTransition
Parameter	Type	Description
StorageClass	StorageClassType	Explanation: Storage class of historical object versions after transition
NoncurrentDays	number	Explanation: Number of days an object is historical before the specified rule takes effect

**Table 10** NoncurrentVersionExpiration
Parameter	Type	Description
NoncurrentDays	number	Explanation: Number of days an object is historical before the specified rule takes effect

**Table 11** AbortIncompleteMultipartUpload
Parameter	Type	Description
DaysAfterInitiation	number	Explanation: Number of days since the initiation of an incomplete multipart upload that OBS will wait before deleting the non-assembled parts (fragments) of the upload

**Table 12** StorageClassType
Constant	Default Value	Description
ObsClient.enums.StorageClassStandard	STANDARD	Standard storage class. Features low access latency and high throughput and is used for storing massive, frequently accessed (multiple times a month) or small objects (< 1 MB) requiring quick response.
ObsClient.enums.StorageClassWarm	WARM	Infrequent Access storage class. Used for storing data that is semi-frequently accessed (fewer than 12 times a year) but becomes instantly available when needed.
ObsClient.enums.StorageClassCold	COLD	Archive storage class. Used for storing rarely accessed (once a year) data.

Code Examples

You can call ObsClient.getBucketLifecycle to view lifecycle rules of a bucket. The following code shows how to obtain the lifecycle rule of bucket examplebucket:

    
     
       
       
         // Import the OBS library.
// Use npm to install the client.
const ObsClient = require("esdk-obs-nodejs");
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
const obsClient = new ObsClient({
  // Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
  // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
  // security_token: process.env.SECURITY_TOKEN,
  // Enter the endpoint corresponding to the region where the bucket is located. CN-Hong Kong is used here in this example. Replace it with the one currently in use.
  server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});

async function getBucketLifecycle() {
  try {
    const params = {
      // Specify the bucket name.
      Bucket: "examplebucket"
    };
    // Obtain the lifecycle rules of the bucket.
    const result = await obsClient.getBucketLifecycle(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s lifecycle configuraion successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      for (let i = 0; i < result.InterfaceResult.Rules.length; i++) {
        const rule = result.InterfaceResult.Rules[i];
        console.log("ID:%s, Prefix:%s, Status:%s, Expiration[Date]:%s, Expiration[Days]:%d, NoncurrentVersionExpiration[NoncurrentDays]:%s",
          rule.ID, rule.Prefix, rule.Status, rule.Expiration.Date,
          rule.Expiration.Days, rule.NoncurrentVersionExpiration.NoncurrentDays
        );
      };
      return;
    };
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};

getBucketLifecycle();

        

      

    
   