更新时间:2025-03-10 GMT+08:00
分享

查询资源血缘关系

功能介绍

查询资源血缘关系。

URI

POST /v1/{project_id}/resources/relationships

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID。获取方法请参见获取工作空间ID

X-Auth-Token

String

用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

resources

Array of resources objects

待查询血缘关系的资源信息列表。

表4 resources

参数

是否必选

参数类型

描述

resource_type

String

参数解释:

资源类型枚举值,用于指定授权对象的类型。

示例:datasource,指定授权对象类型为数据源。

约束限制:

不涉及

取值范围:

以下枚举值:

  • datasource:数据源;
  • dataset:数据集;
  • metric:指标;
  • dashboard:仪表板;
  • screen:大屏;
  • embedAnalysis:嵌入分析;
  • portal:数据门户;
  • subject:智能分析助手。

默认取值:

不涉及

resource_id

String

资源ID。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

resources

Array of ResourceRelationDetailVO objects

资源血缘关系列表。

workspace_id

String

工作空间ID。获取方法请参见获取工作空间ID

表6 ResourceRelationDetailVO

参数

参数类型

描述

resource_id

String

资源ID。

resource_name

String

资源名称。

resource_type

String

参数解释:

资源类型枚举值,用于指定授权对象的类型。

示例:datasource,指定授权对象类型为数据源。

约束限制:

不涉及

取值范围:

以下枚举值:

  • datasource:数据源;
  • dataset:数据集;
  • metric:指标;
  • dashboard:仪表板;
  • screen:大屏;
  • embedAnalysis:嵌入分析;
  • portal:数据门户;
  • subject:智能分析助手。

默认取值:

不涉及

relations

Array of ResourceRelationDetailVO objects

依赖资源列表。

请求示例

查询资源血缘关系。

POST https://{endpoint}/v1/0e****127d****6b7****95750da/resources/relationships
{
  "resources" : [ {
    "resource_type" : "portal",
    "resource_id" : "96334c9****4510a0035dff29a7582b"
  } ]
}

响应示例

状态码: 200

查询资源血缘关系成功。

{
  "resources" : [ {
    "resource_id" : "96334c9923****0a0035dff29a7582b",
    "resource_name" : "测试数据门户",
    "resource_type" : "portal",
    "relations" : [ {
      "resource_id" : "2545c456-****-a6d4-dd8419cac54a",
      "resource_name" : "大屏",
      "resource_type" : "screen",
      "relations" : [ ]
    }, {
      "resource_id" : "12e25f5f-4*****-8468-bdf69c25438f",
      "resource_name" : "仪表板",
      "resource_type" : "dashboard",
      "relations" : [ {
        "resource_id" : "980bc5e2-******4-a168-4d344065bcb3",
        "resource_name" : "数据集",
        "resource_type" : "dataset",
        "relations" : [ {
          "resource_id" : "c4d84a8******ba190c5cabf75dfe",
          "resource_name" : "datasource",
          "resource_type" : "datasource",
          "relations" : [ ]
        } ]
      } ]
    } ]
  } ],
  "workspace_id" : "e10aa3****e713d779c65e74"
}

状态码

状态码

描述

200

查询资源血缘关系成功。

错误码

请参见错误码

相关文档