Help Center/ Distributed Message Service for Kafka/ User Guide/ Managing Instances/ Configuring Kafka Recycling Policies
Updated on 2024-10-10 GMT+08:00
View PDF
Share

Configuring Kafka Recycling Policies

If recycling is enabled, deleted instances and their data are retained in Recycle Bin, and can be recovered during the retention period. Once the retention period expires, instances in Recycle Bin will be deleted permanently.

Recycling is disabled by default.

Recycle Bin is available only in the CN North-Beijing4, CN East-Shanghai1, and CN South-Guangzhou regions.

Constraints

  • Pay-per-use instance in Recycle Bin will not generate fees, but their storage will.
  • Yearly/Monthly instances will be moved to Recycle Bin upon unsubscription. After that, they will not generate fees, but their storage will.
  • Yearly/Monthly instances will be changed to pay-per-use ones upon successful recovery.
  • Removing or unsubscribing instances in the grace or retention period deletes them permanently.

Enabling Recycling

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. In the navigation pane, choose Recycle Bin.
  5. Click Modify Recycling Policy and the Modify Recycling Policy dialog box is displayed.
  6. Enable Recycle Bin, specify Retention Days, and click OK.

    • Deleted instances can be retained for 1 to 7 days.
    • Changes to the retention period apply only to instances deleted after the changes.

Recovering Kafka Instances

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. In the navigation pane, choose Recycle Bin.
  5. Recover Kafka instances using either of the following methods:

    • Select one or more Kafka instances and click Recover in the upper left corner.
    • In the row containing the desired Kafka instance, click Recover.

  6. In the displayed Recover Instance dialog box, click OK.

    It takes 3 to 10 minutes to recover an instance. You can view recovered instances on the DMS for Kafka page.

    Yearly/Monthly instances will be changed to pay-per-use ones upon successful recovery.

Modifying Retention Days

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. In the navigation pane, choose Recycle Bin.
  5. Click Modify Recycling Policy and the Modify Recycling Policy dialog box is displayed.
  6. Modify Retention Days and click OK.

    • Deleted instances can be retained for 1 to 7 days.
    • Changes to the retention period apply only to instances deleted after the changes.

Exporting Instances in the Recycle Bin

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. In the navigation pane, choose Recycle Bin.
  5. Export the instance list using either of the following methods:

    • Select the desired instances and choose Export > Export selected data to an XLSX file to export specified instances.
    • Choose Export > Export all data to an XLSX file to export all instances.

Deleting Instances Permanently

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. In the navigation pane, choose Recycle Bin.
  5. Delete instances using either of the following methods:

    • Select one or more Kafka instances and click Delete in the upper left corner.
    • In the row containing the Kafka instance to be deleted, click Delete.

  6. In the displayed Delete Instance dialog box, enter DELETE and click OK.

    Deleting a Kafka instance in the recycle bin will delete the data in the instance without any backup. Exercise caution when performing this operation.

Disabling Recycling

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. In the navigation pane, choose Recycle Bin.
  5. Click Modify Recycling Policy and the Modify Recycling Policy dialog box is displayed.
  6. Disable Recycle Bin and click OK.
Parent topic: Managing Instances