ListDataSource API でワークスペースデータソースを取得 - Quick BI

指定されたワークスペース配下のすべてのデータソースを照会します。

今すぐお試しください

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

list

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkspaceId	string	必須	ワークスペース ID。	95296e95-****c7d-8af9-dedf0ad0**
DsType	string	任意	データソースタイプ。	mysql

データソースタイプのコード：

garuda -- garuda データソース
adb -- ADB 3.0
oracle -- Oracle データソース
mysql -- MySQL データソース
mysql_hybrid -- HybridDB for MySQL データソース
odps -- ODPS データソース
sqlserver -- SQL Server データソース
greenplum -- Greenplum データソース
postgresql -- PostgreSQL データソース
ppas -- RDS PPAS データソース
oscar -- Shentong データソース
hive -- Hive データソース
vertica -- Vertica データソース
db2 -- IBM DB2 データソース (LUW)
sybase -- SAP SYBASE IQ データソース
hana -- SAP HANA データソース
dla -- DataLake Analytics データソース
oss -- OSS データソース
drds -- DRDS データソース
clivia -- スーパーエンジン
presto -- Presto データソース
polardb -- PolarDB データソース
tsdb -- TSDB データソース
lindorm_tsdb -- LindormTSDB データソース
lindorm_wide_table_engine -- Lindorm ワイドテーブルエンジンデータソース
lindorm_multi_mode -- Lindorm マルチモード SQL データソース
hbase -- HBase データソース
phoenix_thin -- PHOENIX THIN データソース
dataphin -- DataPhin データソースマルチエンジン
dataphin_odps -- DataPhin データソース ODPS エンジン
dataphin_hive -- DataPhin データソース Hive エンジン
dataphin_v2_odps -- 新しい DataPhin データソース ODPS エンジン
dataphin_v2_hive -- 新しい DataPhin データソース Hive エンジン
kbase -- KingBase データソース
clickhouse -- ClickHouse データソース
tdsql -- TDSQL-H データソース
gbase -- Gbase データソース
polardb_pg -- Polardb for PG データソース
hologres -- Hologres データソース
impala -- Impala データソース
impala_v3 -- Impala 3.x データソース
dingtalk -- DingTalk スマートレポートデータソース
snowflake -- Snowflake データソース
kylin -- Kylin データソース
multiDatasource -- クロスソース
oceanbase_mysql -- OceanBase MySQL モードデータソース
oceanbase_oracle -- OceanBase Oracle モードデータソース
spark_sql -- Spark SQL データソース
starrocks -- StarRocks データソース
apache_doris -- Apache Doris データソース
selectdb -- SelectDB データソース
mongodb -- MongoDB データソース
dm -- DM7 データソース
Dameng - unicorn -- Unicorn データソース
sls -- SLS データソース
gaussdb_dws -- GaussDB DWS データソース
gaussdb -- GaussDB データソース
elasticsearch -- Elasticsearch
dms -- DMS 論理データウェアハウス
yida -- Yida アプリケーションデータソース
relyt -- Relyt
Lark_bitable -- Lark bitable
Lark_spreadsheet -- Lark spreadsheet
tidb -- TiDB データソース
mariadb -- MariaDB データソース
adb_spark -- ADB データソース Spark エンジン

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	7FC9A6A6-**-5CED-B***E891E4075
Result	array<object>	データソース情報の配列。
	object	データソース情報。
CreatorId	string	作成者の Quick BI ユーザー ID。	281***-485****-8
CreatorName	string	所有者のニックネーム。	system
DatasourceId	string	データソース ID。	7FC9A6A6-**-5CED-B***E891E4075
GmtCreate	string	データソースの作成時間。フォーマットは yyyy-MM-dd HH:mm:ss です。	2024-04-16 13:17:39
GmtModified	string	更新時間。	2024-08-15 10:06:31
ShowName	string	データソースの表示名。	0327
DsType	string	データソースタイプ。	odps
ParentDsType	string	マルチエンジンデータソースのプライマリデータソースタイプ。	dataphin
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "7FC9A6A6-****-5CED-B*****E891E4075",
  "Result": [
    {
      "CreatorId": "281*****-485******-8",
      "CreatorName": "system",
      "DatasourceId": "7FC9A6A6-****-5CED-B*****E891E4075",
      "GmtCreate": "2024-04-16 13:17:39",
      "GmtModified": "2024-08-15 10:06:31",
      "ShowName": "0327",
      "DsType": "odps",
      "ParentDsType": "dataphin"
    }
  ],
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.Workspace	The workspace is not owned by the organization.
400	Workspace.Operation.LackRole	Only the %s role can perform this operation. Contact the administrator to add this role.
400	Internal.System.Error	An internal system error occurred.
400	Invalid.Param.Error	The parameter is invalid.
400	Invalid.Parameter	An error occurred while verifying parameters.
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Parameter.Length.Exceed	Parameter length exceeds maximum limit: [%s].
400	Parameter.Error	The input parameter is invalid.
400	User.Not.In.Organization	The specified user is not in the organizational unit.
400	Invalid.User.Admin	You are not an administrator of this organization.
400	Invalid.Organization	The specified organizational unit does not exist.
400	Invalid.User.Organization	The user is not in your organization.
400	System.Param.Empty	You must specify the %s parameter.
400	Workspace.Not.Exist	The group workspace does not exist.
400	User.NotIn.Workspace	The user is not in this workspace.

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

変更履歴

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