ExportDataSources - DataWorks - Alibaba Cloud ドキュメントセンター

データソースのリストをエクスポートします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	データソースが属する DataWorks ワークスペースの ID。 ListProjects 操作を呼び出して、ワークスペースの ID を照会できます。	10000
Name	string	任意	エクスポートするデータソースの名前に含まれるキーワード。キーワードは 1 つだけ指定できます。たとえば、このパラメーターを test に設定すると、ExportDataSources 操作を呼び出して、ワークスペース内で名前に test を含むすべてのデータソースをエクスポートできます。	test
DataSourceType	string	任意	データソースのタイプ。一般的なタイプは以下のとおりです。 odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
SubType	string	任意	データソースのサブタイプ。このパラメーターは、DataSourceType パラメーターが rds に設定されている場合にのみ効果を発揮します。 DataSourceType パラメーターの値が rds の場合、このパラメーターの値は mysql、sqlserver、または postgresql になります。	mysql
EnvType	integer	任意	データソースが存在する環境。有効な値: 0: 開発環境 1: 本番環境	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。	1

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	返される HTTP 状態コード。有効な値: 200: リクエストが成功しました。その他の値: リクエストが失敗しました。返された HTTP 状態コードに基づいて問題のトラブルシューティングができます。	200
RequestId	string	リクエスト ID。この ID に基づいてログを特定し、問題のトラブルシューティングができます。	0bc14115159376359****
Success	boolean	リクエストが成功したかどうかを示します。有効な値: true: 成功 false: 失敗	true
Data	object	エクスポートされたデータソースの情報。
PageNumber	integer	ページ番号。ページは 1 から始まります。	10
PageSize	integer	1 ページあたりのエントリ数。	1
TotalCount	integer	条件を満たすデータソースの総数。	100
DataSources	array<object>	エクスポートされたデータソースの詳細。値は配列です。以下のパラメーターは配列内の要素です。これらのパラメーターのサンプル値は、サンプルデータソースの詳細を示しています。
	object
Status	integer	データソースが利用可能かどうかを示します。有効な値: 1: データソースは利用可能です。 0: データソースは利用できません。	1
ProjectId	integer	データソースが属する DataWorks ワークスペースの ID。	123
SubType	string	データソースのサブタイプ。このパラメーターは、DataSourceType パラメーターが rds に設定されている場合にのみ効果を発揮します。 DataSourceType パラメーターの値が rds の場合、このパラメーターの値は mysql、sqlserver、または postgresql になります。	mysql
GmtModified	string	データソースが最後に変更済みとなった時間。例: Mar 17, 2021 4:09:32 PM。	Mar 17, 2021 4:09:32 PM
EnvType	integer	データソースが存在する環境。有効な値: 0: 開発環境 1: 本番環境	1
ConnectStatus	integer	データソースが排他的リソースグループに接続されているかどうかを示します。有効な値: 1: データソースは少なくとも 1 つの排他的リソースグループに接続されています。 0: データソースはどの排他的リソースグループにも接続されていません。	1
Sequence	integer	データソースのシーケンス番号。	300
Description	string	データソースの説明。	a connection
DataSourceType	string	データソースのタイプ。一般的なタイプは以下のとおりです。 odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
GmtCreate	string	データソースが作成された時間。例: Mar 17, 2021 4:09:32 PM。	Mar 17, 2021 4:09:32 PM
DefaultEngine	boolean	データソースがバインドされているコンピュートエンジンがデフォルトのコンピュートエンジンかどうかを示します。有効な値: true: コンピュートエンジンはデフォルトのコンピュートエンジンです。 false: コンピュートエンジンはデフォルトのコンピュートエンジンではありません。	false
Shared	boolean	データソースを共有できるかどうかを示します。有効な値: true: データソースを共有できます。 false: データソースを共有できません。	false
Operator	string	データソースを操作したユーザーの ID。	193543050****
Name	string	データソースの名前。	abc
Content	string	データソースの構成。	{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}
Id	integer	データソース ID。	1
BindingCalcEngineId	integer	データソースがバインドされているコンピュートエンジンの ID。	123
TenantId	integer	データソースが属するテナントの ID。	1234567

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "0bc14115159376359****",
  "Success": true,
  "Data": {
    "PageNumber": 10,
    "PageSize": 1,
    "TotalCount": 100,
    "DataSources": [
      {
        "Status": 1,
        "ProjectId": 123,
        "SubType": "mysql",
        "GmtModified": "Mar 17, 2021 4:09:32 PM",
        "EnvType": 1,
        "ConnectStatus": 1,
        "Sequence": 300,
        "Description": "a connection",
        "DataSourceType": "rds",
        "GmtCreate": "Mar 17, 2021 4:09:32 PM",
        "DefaultEngine": false,
        "Shared": false,
        "Operator": "193543050****",
        "Name": "abc",
        "Content": "{\"pubEndpoint\":\"http://service.cn.maxcompute.aliyun.com/api\",\"accessId\":\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\",\"securityToken\":null,\"endpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"accessKey\":\"***\",\"name\":\"PRE_PROJECT_A_engine\",\"project\":\"PRE_PROJECT_A\",\"vpcEndpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"region\":\"cn-shanghai\",\"authType\":\"2\"}",
        "Id": 1,
        "BindingCalcEngineId": 123,
        "TenantId": 1234567
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.DI.Parameter	The parameter is invalid.
500	InternalError.DI.Parameter	A DI internal error occurred.
403	Forbidden.DI.NoPrivilege	No access.

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

変更履歴

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