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

:QueryDatasetDetailInfo

最終更新日:May 28, 2026

指定されたデータセットの詳細 (データソース、ディレクトリ、データセットモデルなど) を取得します。

操作説明

応答には、データソース、ディレクトリ、およびデータセットモデル (ディメンション、メジャー、物理フィールド、カスタム SQL テキスト、リレーションシップを含む) が返されます。

今すぐお試しください

この 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:QueryDatasetDetailInfo

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DatasetId

string

必須

データセット ID。

5820f58c-c734-4d8a-baf1-7979af4f****

レスポンスフィールド

フィールド

説明

object

レスポンスボディ。

RequestId

string

リクエスト ID。

DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

Result

string

データセットの詳細。JSON 形式で返されます: { "cube": { "dimensions": [ { "caption": "Customer Name", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "customer_name", "uid": "N5820f5_customer_name" }, { "caption": "Order ID", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "order_id", "uid": "N5820f5_order_id" }, ], "measures": [ { "caption": "Order Amount", "dataType": "number", "factColumn": "order_amt", "measureType": "standard_measure", "uid": "N5820f5_order_amt" } ], "table": { "customsql": false, "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****", "tableName": "company_sales_record_copy" } }, "datasetId": "5820f58c-c734-4d8a-baf1-7979af4f****", "datasetName": "company_sales_record_copy12", "datasource": { "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****", "dsName": "User's Private DB", "dsType": "mysql" }, "directory": { "id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****", "name": "My Datasets", "pathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****", "pathName": "My Datasets" }, "ownerId": "13651626232****", "ownerName": "田中一郎", "rowLevel": false, "workspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad0****", "workspaceName": "Test Workspace" }

返回JSON格式的数据集数据,详见左侧说明。

Success

boolean

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

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

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

true

成功レスポンス

JSONJSON

{
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": "返回JSON格式的数据集数据,详见左侧说明。",
  "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Cube.Not.Exist The Cube does not exist.
400 Not.WorkspaceCube.Error You can only use the %s dataset of the current workspace. 現在のワークスペースのデータセットのみを使用できます。
400 DatasourceId.IsNull.Error You must select a data source before selecting the table. テーブルを選択する前に、データソースを選択する必要があります。
400 Datasource.UserPermission.Error You do not have datasource authorization.
400 CubeDimension.NotExist.Error The dimension does not exist in the dataset. The dimension ID is %s.

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

変更履歴

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