すべてのプロダクト
Search
ドキュメントセンター

:QueryWorksBloodRelationship

最終更新日:Dec 24, 2025

データワークの血縁関係を取得します。これには、各コンポーネントが参照するデータセットやクエリフィールド情報が含まれます。現在、サポートされているデータワークは、ダッシュボード、ワークブック、セルフサービスデータ取得のみです。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:QueryWorksBloodRelationship

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

WorksId

string

必須

データワークの ID。

abcd****

レスポンスフィールド

フィールド

説明

object

応答。

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

RequestId

string

リクエストの ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

array<object>

ワークの血縁情報のリスト。

array<object>

ComponentId

string

コンポーネントの ID。

0696083a-ca72-4d89-8e7a-c017910e0***

ComponentName

string

コンポーネントの名前。

线图

ComponentType

integer

コンポーネントのタイプ。

3

ComponentTypeName

string

コンポーネントタイプの名前。

LINE

ComponentTypeCnName

string

コンポーネントタイプの中国語名。

交叉表

DatasetId

string

指定されたカスタム言語モデルから削除するトレーニングデータセットの ID です。

dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record

QueryParams

array<object>

クエリパラメーターの参照列のリスト。

object

AreaId

string

所有ロケーションの ID。

area_column

AreaName

string

所有ロケーションの名前。

列(度量)

Caption

string

フィールドの表示名。

order_number

DataType

string

フィールドのタイプ。有効な値:

  • string:文字列型

  • date:年、月、日のみを含む日付型

  • datetime:一般的な日時型

  • time:時、分、秒のみを含む日付型

  • number:数値型

  • boolean:ブール型

  • geographical:地理的位置

  • url:URL 型

  • imageUrl:画像リンクのタイプ

  • multivalue:複数値列

number

IsMeasure

boolean

メトリックかどうかを示します。有効な値:

true、false

true

PathId

string

グローバルに一意の PathId。

schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]

Uid

string

フィールドの一意の ID。

Ndc78a4_order_number

Expression

string

計算フィールドの式。

BI_DATEADD([时间], 100, 'day')

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
      "ComponentName": "线图",
      "ComponentType": 3,
      "ComponentTypeName": "LINE",
      "ComponentTypeCnName": "交叉表",
      "DatasetId": "dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record",
      "QueryParams": [
        {
          "AreaId": "area_column",
          "AreaName": "列(度量)",
          "Caption": "order_number",
          "DataType": "number",
          "IsMeasure": true,
          "PathId": "schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]",
          "Uid": "Ndc78a4_order_number",
          "Expression": "BI_DATEADD([时间], 100, 'day')"
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid.Works.Empty This work does not exist. It may have been deleted. Work ID is %s.
400 Invalid.WorksId.Not.Publish Works %s is not published yet.
400 Invalid.Workspace The workspace is not owned by the organization.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。