更新时间:2024-09-12 GMT+08:00
分享

元数据实时同步接口(邀测)

功能介绍

元数据实时同步接口,支持批量。该接口功能处于邀测阶段,后续将随功能公测将逐步开放。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

表3 请求Body参数

参数

是否必选

参数类型

描述

engine

String

引擎服务名称。

engine_version

String

引擎版本信息。

instance_id

String

引擎的实例ID, MRS、DWS必填。

project_id

String

项目ID,DLI必填。

events

Array of CatalogMetaDataEventInfo objects

资产信息。

表4 CatalogMetaDataEventInfo

参数

是否必选

参数类型

描述

event_ts

Long

事件发生时的时间戳。

event_type

String

事件类型,

  • AddForeignKeyEvent 添加外键

  • AddNotNullConstraintEvent 添加不为空约束

  • AddPrimaryKeyEvent 添加主键

  • AddUniqueConstraintEvent 添加唯一约束

  • AlterDatabaseEvent 修改数据库

  • AddPartitionEvent 添加分区

  • AlterPartitionEvent 修改分区

  • AlterTableEvent 修改表

  • AlterCatalogEvent 修改目录

  • CreateCatalogEvent创建目录

  • CreateDatabaseEvent 创建数据库

  • CreateFunctionEvent 创建函数

  • CreateTableEvent 创建表

  • DropConstraintEvent 删除约束

  • DropDatabaseEvent删除数据库

  • DropFunctionEvent删除函数

  • DropPartitionEvent删除分区

  • DropTableEvent删除表

  • DropCatalogEvent删除目录

  • AddIndexEvent 添加索引

  • AlterIndexEvent 修改索引

  • DropIndexEvent 删除索引

  • AlterSchemaEvent修改schema

  • CreateSchemaEvent创建schema

  • DropSchemaEvent 删除schema

  • AlterColumnEvent 修改字段

  • AddColumnEvent添加字段

  • DropColumnEvent删除字段

  • AlterTriggerEvent修改触发器

  • AddTriggerEvent 添加触发器

  • DropTriggerEvent删除触发器

event_message

Object

事件消息,Map<String,Object>结构。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

success

Boolean

是否成功。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

{
  "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"
      }
    }
  } ]
}

响应示例

状态码: 200

OK。

{
  "success" : true
}

SDK代码示例

SDK代码示例如下。

 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
48
49
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();
        CatalogMetaDataEventRequest body = new CatalogMetaDataEventRequest();
        request.withBody(body);
        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
32
33
# 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()
        request.body = CatalogMetaDataEventRequest(
        )
        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
38
39
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{}
	request.Body = &model.CatalogMetaDataEventRequest{
	}
	response, err := client.BatchSyncMetadata(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK。

400

BadRequest。

401

Unauthorized。

403

Forbidden。

404

Not Found。

相关文档