QueryDatasetInfo API でのデータセット情報取得 - Quick BI

テーブルがカスタム SQL テーブルであるかどうかを示します。有効な値は次のとおりです。 \\* true：カスタム SQL テーブル \\* false：カスタム 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:QueryDatasetInfo

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DatasetId	string	必須	指定されたデータセットに関する情報を照会します。	a201c85c-******

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	操作が正常に返されたかどうかを示します。有効な値： true：呼び出しは成功です。 false：呼び出しは失敗です。	a4d1a221d-41za1-****
Result	object	データセット情報。
CubeTableList	array<object>	データセットの一意の ID。
	object
Caption	string	データソーステーブルが有効かどうかを示します。有効な値： true：データソーステーブル false：カスタムテーブル	odps_40
Customsql	boolean	テーブルの表示名。	false
DatasourceId	string	テーブルの名前。	dfefd7f4-fc6e-42c9-b4******
DsType	string	データソースの ID。	maxcompute
FactTable	boolean	テーブルの一意の ID。	true
Sql	string	テーブルがカスタム SQL テーブルであるかどうかを示します。有効な値： true：カスタム SQL テーブル false：カスタム SQL テーブル以外	select * from ****
TableName	string	データセットが使用するテーブルのリスト。	viewdasb8494aab2612473cb74992159fe****
UniqueId	string	データソースのタイプ。有効な値： mysql odps oracle ... および Quick BI がサポートする他のデータソースタイプ	7a62530b36
CustimzeSql	boolean	データセットが属するワークスペースの一意の ID。	false
DatasetId	string	データソースのタイプ。有効な値： mysql odps oracle ... Quick BI がサポートするデータソースタイプなど	a201c85c-******
DatasetName	string	Quick BI におけるデータセットオーナーのユーザー ID。	opds_40
DimensionList	array<object>	データセット内のすべてのディメンションのリスト。
	object
Caption	string	グループメジャーによって参照されるフィールドの一意の ID。メトリックがグループ化メトリックである場合にのみ NULL 以外になります。	city
DataType	string	データセット内のすべてのディメンションのリスト。	string
DimensionType	string	実際の物理フィールド。	group_dimension
Expression	string	データタイプ。値： string：文字 number：数値 datetime：時間	example_expression
FactColumn	string	計算ディメンションの式。計算ディメンションの場合にのみ有効です。	city
FieldDescription	string	フィールドの説明。	hhhh
Granularity	string	ディメンションのタイプ。有効な値： standard_dimension：一般ディメンション calculate_dimension：計算ディメンション group_dimension：グループ化ディメンション	example_granularity
RefUid	string	粒度。	308f7****
TableUniqueId	string	ARN。	7a62530***
Uid	string	ディメンションの表示名。	a69774***
ExpressionV2	string	フラット化された計算ディメンションの式。	example_expression
Directory	object	メトリックの一意の ID。
Id	string	テストディレクトリ	a3eecab7-618d-4f9f-*****
Name	string	テストディレクトリ	测试目录
PathId	string	データセットが属するディレクトリに関する情報。	88b680****
PathName	string	ディレクトリ ID のパス (例：aa/bb/cc/dd)。	测试目录
DsId	string	データソースの名前。	a201c85c-******
DsName	string	データセットが最後に変更された時刻。	odps
DsType	string	トレーニングデータセットが作成された時点。	odps
GmtCreate	string	SQL 文をカスタマイズするかどうかを示します。有効な値： true false	1629450382000
GmtModify	string	データセット情報。	1629450382000
MeasureList	array<object>	データセットのすべてのメジャーのリスト。
	object
Caption	string	実際の物理フィールド。	profit_amt
DataType	string	データセットのすべてのメジャーのリスト。	string
Expression	string	データタイプ。値： string：文字 number：数値 datetime：時間	example_expression
FactColumn	string	メジャーのタイプ。有効な値： standard_measure：一般メトリック calculate_measure：計算メジャー	profit_amt
FieldDescription	string	フィールドの説明。	asadsda
MeasureType	string	メジャーを計算する式。計算メジャーの場合にのみ有効です。	calculate_measure
TableUniqueId	string	メトリックの表示名。	7a62530b36
Uid	string	テーブルが属するテーブルの一意の ID。CubeTypeList の UniqueId に対応します。	88b680****
ExpressionV2	string	フラット化された計算メトリックの式。	example_expression
OpenOfflineAcceleration	boolean	抽出アクセラレーションを有効にするかどうか。有効な値： true false	false
OwnerId	string	テストスペース	b8494aab26124*****
OwnerName	string	データソースの一意の ID。	大娃
RowLevel	boolean	トレーニングデータセットの名前。	false
WorkspaceId	string	行レベルの権限が有効になっているかどうか。有効な値： true：VIP Netty チャネルは有効です。 false：VIP Netty チャネルは無効です。	420abef4-a79b-4289-b12****
WorkspaceName	string	ビッグベビー	测试空间
Success	boolean	データセットの一意の ID。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "a4d1a221d-41za1-****",
  "Result": {
    "CubeTableList": [
      {
        "Caption": "odps_40",
        "Customsql": false,
        "DatasourceId": "dfefd7f4-fc6e-42c9-b4******",
        "DsType": "maxcompute",
        "FactTable": true,
        "Sql": "select * from ****",
        "TableName": "viewdasb8494aab2612473cb74992159fe****",
        "UniqueId": "7a62530b36"
      }
    ],
    "CustimzeSql": false,
    "DatasetId": "a201c85c-******",
    "DatasetName": "opds_40",
    "DimensionList": [
      {
        "Caption": "city",
        "DataType": "string",
        "DimensionType": "group_dimension",
        "Expression": "example_expression",
        "FactColumn": "city",
        "FieldDescription": "hhhh",
        "Granularity": "example_granularity",
        "RefUid": "308f7****",
        "TableUniqueId": "7a62530***",
        "Uid": "a69774***",
        "ExpressionV2": "example_expression"
      }
    ],
    "Directory": {
      "Id": "a3eecab7-618d-4f9f-*****",
      "Name": "测试目录",
      "PathId": "88b680****",
      "PathName": "测试目录"
    },
    "DsId": "a201c85c-******",
    "DsName": "odps",
    "DsType": "odps",
    "GmtCreate": "1629450382000",
    "GmtModify": "1629450382000",
    "MeasureList": [
      {
        "Caption": "profit_amt",
        "DataType": "string",
        "Expression": "example_expression",
        "FactColumn": "profit_amt",
        "FieldDescription": "asadsda",
        "MeasureType": "calculate_measure",
        "TableUniqueId": "7a62530b36",
        "Uid": "88b680****",
        "ExpressionV2": "example_expression"
      }
    ],
    "OpenOfflineAcceleration": false,
    "OwnerId": "b8494aab26124*****",
    "OwnerName": "大娃",
    "RowLevel": false,
    "WorkspaceId": "420abef4-a79b-4289-b12****",
    "WorkspaceName": "测试空间"
  },
  "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	Decryption.Error	An error occurred while decoding.	復号化中にエラーが発生しました。
400	Datasource.UserPermission.Error	You do not have datasource authorization.
400	CubeMeta.ToXml.Error	An error occurred while converting the data object to the XML format.	データオブジェクトの XML を作成中にエラーが発生しました。
400	Datasource.NotFound.Error	The specified data source does not exist: %s.	指定されたデータソースは存在しません：%s。
400	Cube.ParseToXml.Error	An error occurred while parsing a dataset object to XML format.	ディメンションまたはメジャーはありません。
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.	テーブルを選択する前に、データソースを選択する必要があります。

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

変更履歴

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