Skip to content

Convert Materialized Acceleration to External Acceleration

API Description

This API converts an existing materialization plan, such as acceleration materialization (ACCELERATE) or result materialization (RESULT), into an external materialization plan (EXTERNAL). Use it when the user wants to take over table creation, backfill, and scheduling through an external scheduler.

API URL

POST /anymetrics/api/v1/accelerate/plan/transform

Request parameters

Common Request Headers

parameter Type required Description
tenant-id String Yes Tenant ID, used to identify the tenant for metric query content.
auth-type String Yes Authentication method. Supports UID, TOKEN, ACCOUNT, and APIKEY.
auth-value String Yes Authentication value corresponding to auth-type.

How to Obtain Common parameters

You can view this in the top navigation of Aloudata CAN under Metric Applications > API Integration.

image.png

Request parameters

Field Type required Description
uuid String Yes Unique identifier of the plan to convert
materializeType String Yes Target materialization type. It must be "EXTERNAL"

Request Example

{
  "uuid": "ecfc2a9539a04ef49897a9b4e3d65e7f",
  "materializeType": "EXTERNAL"
}

Response parameter Description

Field Type Description
data String returns "success" after a successful call
success Boolean Whether successful
code String Response code
errorMsg String Error message
detailErrorMsg String Detailed error message

Response Example

{
  "data": "success",
  "success": true,
  "code": "200",
  "errorMsg": null
}

Usage Notes

  • After conversion, the plan becomes external materialization and the system no longer schedules it automatically.

  • The plan UUID remains unchanged before and after conversion, so frontend display is not affected.

  • After conversion, obtain table-creation and backfill scripts through the following API:
    ➜ /accelerate/plan/queryReferenceScript

  • The conversion cannot be reversed. Make sure the business owner has confirmed it.