Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map/ Synchronizing Metadata in Real Time (Invitational Test)
Updated on 2026-07-02 GMT+08:00

Synchronizing Metadata in Real Time (Invitational Test)

Function

This API is used to synchronize metadata in real time. It is in invitational test and will be available for OBT in the future.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/metadata/async-bulk

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

engine

No

String

Engine service name.

engine_version

No

String

Engine version information.

instance_id

No

String

Instance ID of the engine. This parameter is mandatory for MRS and DWS.

project_id

No

String

Project ID. This parameter is mandatory for DLI.

events

No

Array of CatalogMetaDataEventInfo objects

Asset information.

Table 4 CatalogMetaDataEventInfo

Parameter

Mandatory

Type

Description

event_ts

No

Long

Indicates the timestamp when an event occurs.

event_type

No

String

Event type

  • AddForeignKeyEvent: adding a foreign key

  • AddNotNullConstraintEvent: adding a non-null constraint

  • AddPrimaryKeyEvent: adding a primary key

  • AddUniqueConstraintEvent: adding a unique constraint

  • AlterDatabaseEvent: modifying a database

  • AddPartitionEvent: adding a partition

  • AlterPartitionEvent: modifying a partition

  • AlterTableEvent: modifying a table

  • AlterCatalogEvent: modifying a catalog

  • CreateCatalogEvent: creating a catalog

  • CreateDatabaseEvent: creating a database

  • CreateFunctionEvent: creating a function

  • CreateTableEvent: creating a table

  • DropConstraintEvent: deleting a constraint

  • DropDatabaseEvent: deleting a database

  • DropFunctionEvent: deleting a function

  • DropPartitionEvent: deleting a partition

  • DropTableEvent: deleting a table

  • DropCatalogEvent: deleting a catalog

  • AddIndexEvent: adding an index

  • AlterIndexEvent: modifying an index

  • DropIndexEvent: deleting an index

  • AlterSchemaEvent: modifying a schema

  • CreateSchemaEvent: creating a schema

  • DropSchemaEvent: deleting a schema

  • AlterColumnEvent: modifying a field

  • AddColumnEvent: adding a field

  • DropColumnEvent: deleting a field

  • AlterTriggerEvent: modifying a trigger

  • AddTriggerEvent: adding a trigger

  • DropTriggerEvent: deleting a trigger

event_message

No

Object

Event message, which is a Map<String,Object> structure.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

success

Boolean

Whether the request is successful.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "engine" : "MRS",
  "engine_version" : "3.1.2",
  "instance_id" : "4bacc6b5-9e94-4938-ac3f-3c3a7cd56c01",
  "events" : [ {
    "event_ts" : 0,
    "event_type" : "CreateTableEvent",
    "event_message" : {
      "table" : {
        "tableName" : "testTb1"
      }
    }
  } ]
}

Example Responses

Status code: 200

OK.

{
  "success" : true
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class BatchSyncMetadataSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchSyncMetadataRequest request = new BatchSyncMetadataRequest();
        try {
            BatchSyncMetadataResponse response = client.batchSyncMetadata(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchSyncMetadataRequest()
        response = client.batch_sync_metadata(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchSyncMetadataRequest{}
	response, err := client.BatchSyncMetadata(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.