データソースのビジネス情報を基に、データソースの一覧をクエリします。
操作説明
この API オペレーションは、DataWorks のすべてのエディションで利用可能です。
DataWorks で以下のいずれかのロールが割り当てられている場合にのみ、このオペレーションを呼び出すことができます。
テナント所有者、ワークスペース管理者、デプロイ、開発、ビジター、ワークスペース所有者、O&M、モデルデザイナー、セキュリティ管理者、データアナリスト、OpenPlatform 管理者、データガバナンス管理者
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:ListDataSources |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
DataWorks ワークスペース ID。ご利用の DataWorks コンソール にログインし、[ワークスペース] ページから ID を確認できます。 このパラメーターを設定して、API オペレーションを適用する DataWorks ワークスペースを指定する必要があります。 |
17820 |
| Name |
string |
任意 |
データソースの名前。データソース名によるあいまい検索がサポートされています。 |
test |
| Types |
array |
任意 |
データソースの種別。このパラメーターはフィルター条件として機能します。複数のデータソース種別を指定できます。 |
|
|
string |
任意 |
データソースの種別。 |
mysql |
|
| EnvType |
string |
任意 |
データソースが使用される環境。有効な値は以下のとおりです。
|
Prod |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりの表示件数。デフォルト値：10。最大値：100。 |
10 |
| SortBy |
string |
任意 |
データソースを並べ替える際に使用するフィールド。有効な値は以下のとおりです。
デフォルト値：CreateTime |
Id |
| Order |
string |
任意 |
データソースの並べ替え順序。有効な値は以下のとおりです。
デフォルト値：Desc |
Asc |
| Tags |
string |
任意 |
データソースのタグ。このパラメーターはフィルター条件として機能します。
|
["tag1", "tag2", "tag3"] |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
7BE1433F-6D55-5D86-9344-CA6F7DD19B13 |
| PagingInfo |
object |
ページネーション情報。 |
|
| TotalCount |
integer |
返された合計件数。 |
131 |
| PageSize |
integer |
1 ページあたりの表示件数。 |
10 |
| PageNumber |
integer |
ページ番号。 |
1 |
| DataSources |
array<object> |
データソースグループ。配列内の各要素は 1 つのデータソースグループを表します。各データソースグループには、開発環境（存在する場合）および本番環境のデータソースが含まれます。 |
|
|
array<object> |
データソースグループの情報。開発環境（存在する場合）および本番環境のデータソースが含まれます。開発環境および本番環境のデータソースは、データソース名およびデータソース種別が同一ですが、データソース ID は異なります。 |
||
| Name |
string |
データソースの名前。 |
test |
| Type |
string |
データソースの種別。 |
mysql |
| DataSource |
array<object> |
データソース。各要素は、一意のデータソース ID を持つ単一のデータソースの情報を表します。 |
|
|
object |
データソースの情報。 |
||
| Id |
integer |
データソースの ID。 |
16035 |
| ConnectionProperties |
any |
データソースの接続構成。接続アドレス、アクセス ID、環境情報などが含まれます。envType パラメーターは、データソースが使用される環境を指定します。envType パラメーターの有効な値は以下のとおりです。
データソースの追加モードに応じて、設定が必要なパラメーターが異なります。詳細については、「データソース接続情報 (ConnectionProperties)」をご参照ください。 |
{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" } |
| ConnectionPropertiesMode |
string |
データソースの追加モード。データソースの種別に応じてモードが異なります。有効な値は以下のとおりです。
|
UrlMode |
| Description |
string |
データソースの説明。 |
test |
| CreateTime |
integer |
データソースが追加された時刻。この値は UNIX タイムスタンプです。 |
1648711113000 |
| CreateUser |
string |
データソースを追加したユーザーの ID。 |
1624387842781448 |
| ModifyTime |
integer |
データソースが最後に変更された時刻。この値は UNIX タイムスタンプです。 |
1648711113000 |
| ModifyUser |
string |
データソースを変更したユーザーの ID。 |
1624387842781448 |
| QualifiedName |
string |
データソースのユニークなビジネスキー。たとえば、Hologres データソースのユニークなビジネスキーは、 |
1648711121000:cn-beijing:odps:yongxunQA_beijing_standard |
例
成功レスポンス
JSONJSON
{
"RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
"PagingInfo": {
"TotalCount": 131,
"PageSize": 10,
"PageNumber": 1,
"DataSources": [
{
"Name": "test",
"Type": "mysql",
"DataSource": [
{
"Id": 16035,
"ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n \"database\": \"testdb\",\n \"securityProtocol\": \"authTypeNone\",\n \"authType\": \"Executor\",\n \"authIdentity\": \"1107550004253538\"\n}",
"ConnectionPropertiesMode": "UrlMode",
"Description": "test ",
"CreateTime": 1648711113000,
"CreateUser": "1624387842781448",
"ModifyTime": 1648711113000,
"ModifyUser": "1624387842781448",
"QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
}
]
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。