更新时间:2024-11-22 GMT+08:00

查询关系

功能介绍

通过关系名称(支持模糊查询)、创建人、开始时间、结束时间等分页查找关系信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/design/relation

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

name

String

按名称或编码模糊查询。

create_by

String

按创建者查询。

begin_time

String

时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效。格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

end_time

String

时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效。格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

limit

Integer

每页查询条数,即查询Y条数据。默认值50,取值范围[1,100]。

offset

Integer

查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整,默认值0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

使用Token认证时必选。

workspace

String

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

X-Project-Id

String

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

多project场景采用AK/SK认证的接口请求,则该字段必选。

Content-Type

String

默认值:application/json;charset=UTF-8

可选,有Body体的情况下必选,没有Body体则无需填写和校验。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

data object

data,统一的返回结果的最外层数据结构。

表5 data

参数

参数类型

描述

value

value object

value,统一的返回结果的外层数据结构。

表6 value

参数

参数类型

描述

total

Integer

总量。

records

Array of RelationVO objects

RelationVO信息。

表7 RelationVO

参数

参数类型

描述

id

String

编码,ID字符串。

source_table_id

String

源表ID,ID字符串。

target_table_id

String

目标表ID,ID字符串。

name

String

关系名称。

source_table_name

String

源表名称。

target_table_name

String

目的表名称。

role

String

角色。

tenant_id

String

租户ID。

source_type

String

关系类型,只读。

枚举值:

  • ONE: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中有且只有一条数据与之对应。

  • ZERO_OR_ONE: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中最多有一条数据与之对应。

  • ZERO_OR_N: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中可能有多条数据与之对应。

  • ONE_OR_N: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中至少有一条数据与之对应。

target_type

String

关系类型,只读。

枚举值:

  • ONE: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中有且只有一条数据与之对应。

  • ZERO_OR_ONE: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中最多有一条数据与之对应。

  • ZERO_OR_N: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中可能有多条数据与之对应。

  • ONE_OR_N: 表示每条子(父)逻辑实体数据在父(子)逻辑实体中至少有一条数据与之对应。

create_by

String

创建人。

update_by

String

更新人。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

update_time

String

更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

mappings

Array of RelationMappingVO objects

表属性信息,只读。

表8 RelationMappingVO

参数

参数类型

描述

id

String

编码,ID字符串。

relation_id

String

关系ID,ID字符串。

source_field_id

String

源字段ID,ID字符串。

target_field_id

String

目标字段ID,ID字符串。

source_field_name

String

源表名称。

target_field_name

String

目的表名称。

create_by

String

创建人。

update_by

String

更新人。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

update_time

String

更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

根据请求参数,获取关系列表。

GET https://{endpoint}/v2/{project_id}/design/relation?offset=1&limit=100

响应示例

状态码: 200

Success,返回data数据是RelationVO数组,以及总数。

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "id" : "1225137038202957824",
        "source_table_id" : "1225137036110000128",
        "target_table_id" : "1225137037896773632",
        "name" : "left_relation_right_test",
        "source_table_name" : "test_left_relation",
        "target_table_name" : "test_right_test",
        "role" : null,
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70",
        "source_type" : "ONE",
        "target_type" : "ONE",
        "create_by" : "test_uesr",
        "update_by" : "test_uesr",
        "create_time" : "2024-04-03T17:37:12+08:00",
        "update_time" : "2024-04-03T17:37:12+08:00",
        "mappings" : [ {
          "id" : "1225137038211346432",
          "relation_id" : "1225137038202957824",
          "source_field_id" : "1225137036294549504",
          "target_field_id" : "1225137037896773633",
          "source_field_name" : "id",
          "target_field_name" : "id",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "create_time" : "2024-04-03T17:37:12+08:00",
          "update_time" : "2024-04-03T17:37:12+08:00"
        } ]
      } ]
    }
  }
}

状态码: 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

状态码: 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

状态码: 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

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

    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();
        ListRelationsRequest request = new ListRelationsRequest();
        try {
            ListRelationsResponse response = client.listRelations(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 = ListRelationsRequest()
        response = client.list_relations(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.ListRelationsRequest{}
	response, err := client.ListRelations(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success,返回data数据是RelationVO数组,以及总数。

400

BadRequest

401

Unauthorized

403

Forbidden