更新时间:2024-04-28 GMT+08:00
分享

用户行为分析(邀测)

功能介绍

用户行为分析,该接口功能处于邀测阶段,后续将随功能公测将逐步开放。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/datamap/uba

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:32

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:65536

instance

String

实例ID,获取方法请参见实例ID和工作空间ID

最小长度:32

最大长度:36

表3 请求Body参数

参数

是否必选

参数类型

描述

event

String

事件名称。

枚举值:

  • catalog_search_click_entity 查看详情

  • search_catalog 搜索资产

params

Array of EventParam objects

事件参数。

表4 EventParam

参数

是否必选

参数类型

描述

guid

String

资产guid。

type_name

String

资产类型。

model_id

String

模块id。

property_name

String

参数名称。

property_value

String

参数值。

query

String

搜索框输入。

filter

DataMapFilterCriteria object

查询过滤条件。

guid_list

Array of strings

guid列表。

trace_id

String

跟踪id。

source_trace_id

String

源跟踪id。

metadata_type_name

String

资产类型。

super_type_names

String

资产父类类型。

workspace_ids

Array of strings

空间列表。

表5 DataMapFilterCriteria

参数

是否必选

参数类型

描述

attribute

String

过滤属性维度。

枚举值:

  • base.DataAsset.sourceType 数据源类型

  • typeName 数据类型

  • classifications.name 分类

  • tags.name 标签

  • securityLevel.name 密级

  • workspaceId 空间

operator

String

操作标识符。

枚举值:

  • LT 小于

  • GT 大于

  • LTE 小于等于

  • GTE 大于等于

  • EQ 相等

  • NEQ 不相等

  • IN 在列表中

  • LIKE 任意模糊匹配

  • STARTS_WITH 起始相同匹配

  • ENDS_WITH 结束相同匹配

  • CONTAINS 包含

  • CONTAINS_ANY 包含任意

  • CONTAINS_ALL 包含所有

  • IS_NULL 为空

  • NOT_NULL 不为空

value

Array of strings

属性过滤值,根据attribute变化。如attribute为数据源:base.DataAsset.sourceType,则值可为["dws", "hive"]。

最小长度:1

最大长度:256

数组长度:1 - 20

condition

String

条件拼接准则。

枚举值:

  • OR 或者

  • AND 并且

criterion

Array of DataMapFilterCriteria objects

条件准则。

数组长度:1 - 10

响应参数

状态码: 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

错误描述。

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

{
  "event" : "catalog_search_click_entity",
  "params" : [ {
    "query" : "",
    "guid" : "8050ccb6-14bc-48ea-8984-7dc661e9a2a9"
  } ]
}

响应示例

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 ParseUserBehaviorSolution {

    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();
        ParseUserBehaviorRequest request = new ParseUserBehaviorRequest();
        BehaviorRestBody body = new BehaviorRestBody();
        request.withBody(body);
        try {
            ParseUserBehaviorResponse response = client.parseUserBehavior(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = ParseUserBehaviorRequest()
        request.body = BehaviorRestBody(
        )
        response = client.parse_user_behavior(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.ParseUserBehaviorRequest{}
	request.Body = &model.BehaviorRestBody{
	}
	response, err := client.ParseUserBehavior(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。

500

InternalServerError。

分享:

    相关文档

    相关产品