Gunakan API QueryDatasetInfo untuk informasi dataset - Quick BI - Alibaba Cloud - Quick BI

Apakah tabel merupakan tabel SQL kustom. Nilai valid: \* true: tabel SQL kustom \* false: tabel SQL non-kustom

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryDatasetInfo

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	Mengkueri informasi set data tertentu.	a201c85c-******

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	Whether the operation is successfully returned. Valid values: true: The call is successful. false: The call fails.	a4d1a221d-41za1-****
Result	object	The dataset information.
CubeTableList	array<object>	The unique ID of the dataset.
	object
Caption	string	Indicates whether the data source table is valid. Valid values: true: data source table false: custom table	odps_40
Customsql	boolean	The display name of the table.	false
DatasourceId	string	The name of the table.	dfefd7f4-fc6e-42c9-b4******
DsType	string	The ID of the data source.	maxcompute
FactTable	boolean	The unique ID of the table.	true
Sql	string	Indicates whether the table is a custom SQL table. Valid values: true: custom SQL table false: non-custom SQL table	select * from ****
TableName	string	The list of tables used by the dataset.	viewdasb8494aab2612473cb74992159fe****
UniqueId	string	The type of the data source. Valid values: mysql odps oracle ... and other data source types supported by Quick BI	7a62530b36
CustimzeSql	boolean	The unique ID of the workspace to which the dataset belongs.	false
DatasetId	string	The type of the data source. Valid values: mysql odps oracle ... Data source types supported by Quick BI such as	a201c85c-******
DatasetName	string	The user ID of the dataset owner in the Quick BI.	opds_40
DimensionList	array<object>	A list of all dimensions in the dataset.
	object
Caption	string	The unique ID of the field that is referenced by the group measure. Non-NULL if and only if the metric is a grouping metric.	city
DataType	string	A list of all dimensions in the dataset.	string
DimensionType	string	The actual physical field.	group_dimension
Expression	string	Data type; value: string: character number: a number datetime: time	example_expression
FactColumn	string	Expression for a calculated dimension; valid only for calculated dimensions.	city
FieldDescription	string	The description of the field.	hhhh
Granularity	string	The type of the dimension. Valid values: standard_dimension: General Dimension calculate_dimension: calculating dimensions group_dimension: grouping dimensions	example_granularity
RefUid	string	The granularity.	308f7****
TableUniqueId	string	The ARN.	7a62530***
Uid	string	The display name of the dimension.	a69774***
ExpressionV2	string	Expression for the flattened calculation dimensions.	example_expression
Directory	object	The unique ID of the metric.
Id	string	Test directory	a3eecab7-618d-4f9f-*****
Name	string	Test directory	测试目录
PathId	string	The information about the directory to which the dataset belongs.	88b680****
PathName	string	The path of the directory ID, for example, aa/bb/cc/dd.	测试目录
DsId	string	The name of the data source.	a201c85c-******
DsName	string	The time when the dataset was last modified.	odps
DsType	string	The point in time when the training dataset was created.	odps
GmtCreate	string	Indicates whether to customize SQL statements. Valid values: true false	1629450382000
GmtModify	string	The information about the dataset.	1629450382000
MeasureList	array<object>	A list of all measures for the dataset.
	object
Caption	string	The actual physical field.	profit_amt
DataType	string	A list of all measures for the dataset.	string
Expression	string	Data type; value: string: character number: a number datetime: time	example_expression
FactColumn	string	The type of the measure. Valid values: standard_measure: General Metrics calculate_measure: Calculating Measures	profit_amt
FieldDescription	string	The description of the field.	asadsda
MeasureType	string	An expression that calculates a measure; valid only for calculated measures.	calculate_measure
TableUniqueId	string	The display name of the metric.	7a62530b36
Uid	string	The unique ID of the table to which the table belongs, which corresponds to the UniqueId of the CubeTypeList.	88b680****
ExpressionV2	string	Expression for flattened computation metrics.	example_expression
OpenOfflineAcceleration	boolean	Whether to enable extraction acceleration. Valid values: true false	false
OwnerId	string	Test Space	b8494aab26124*****
OwnerName	string	The unique ID of the data source.	大娃
RowLevel	boolean	The name of the training dataset.	false
WorkspaceId	string	Whether row-level permissions are enabled. Valid values: true: The VIP Netty channel is enabled. false: The VIP Netty channel is disabled.	420abef4-a79b-4289-b12****
WorkspaceName	string	Big Baby	测试空间
Success	boolean	The unique ID of the dataset.	true

Contoh

Respons sukses

JSONformat

{
  "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
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Cube.Not.Exist	The Cube does not exist.	The Cube does not exist.
400	Not.WorkspaceCube.Error	You can only use the %s dataset of the current workspace.	You can only use the dataset of the current workspace.
400	Decryption.Error	An error occurred while decoding.	An error occurred while decoding.
400	Datasource.UserPermission.Error	You do not have datasource authorization.	You do not have datasource authorization.
400	CubeMeta.ToXml.Error	An error occurred while converting the data object to the XML format.	An error occurred while converting the data object to the XML format.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.	The specified data source does not exist: %s.
400	Cube.ParseToXml.Error	An error occurred while parsing a dataset object to XML format.	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.	You must select a data source before selecting the table.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.