すべてのプロダクト
Search
ドキュメントセンター

DataWorks:ListConnections

最終更新日:Sep 29, 2026

データソースのリストを照会します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ProjectId

integer

必須

データソースが属するワークスペースの ID。 ListProjects 操作を呼び出して ID をクエリできます。

76086

Name

string

任意

クエリするデータソースの名前。

abc

ConnectionType

string

任意

データソースのタイプ。一般的な値は次のとおりです。

  • odps

  • mysql

  • rds

  • oss

  • sqlserver

  • polardb

  • oracle

  • mongodb

  • emr

  • postgresql

  • analyticdb_for_mysql

  • hybriddb_for_postgresql

  • holo

rds

SubType

string

任意

データソースのサブタイプ。このパラメーターは、タイプにサブタイプが含まれるシナリオで使用されます。次のタイプとサブタイプがサポートされています。

  • タイプ: rds

  • サブタイプ: mysql、sqlserver、postgresql

mysql

Status

string

任意

データソースのステータス。有効な値:

  • ENABLED: 正常。

  • DISABLED: 無効。

ENABLED

EnvType

integer

任意

データソースが使用される環境。有効な値: 0 および 1。値 0 は開発環境を示します。値 1 は本番環境を示します。

1

PageSize

integer

任意

ページサイズ。デフォルト値: 10。最大値: 100。

10

PageNumber

integer

任意

ページ番号。ページは 1 から始まります。

1

レスポンスフィールド

フィールド

型

説明

例

object

HttpStatusCode

integer

HTTP 状態コード。

200

RequestId

string

リクエスト ID。

0bc14115159376359****

Success

boolean

リクエストが成功したかどうかを示します。

true

Data

object

複数ページで返されるデータソースのクエリ結果。

PageNumber

integer

ページ番号。

1

PageSize

integer

ページサイズ。デフォルト値: 10。最大値: 100。

20

TotalCount

integer

返されるデータソースの総数。

3

Connections

array<object>

データソース。

object

Status

integer

データソースのステータス。有効な値:

  • 1: データソースは正常です。

  • 2: データソースは無効です。

1

ConnectionType

string

データソースのタイプ。一般的な値は次のとおりです。

  • odps

  • mysql

  • rds

  • oss

  • sqlserver

  • polardb

  • oracle

  • mongodb

  • emr

  • postgresql

  • analyticdb_for_mysql

  • hybriddb_for_postgresql

  • holo

mysql

ProjectId

integer

データソースが関連付けられているワークスペースの ID。

123

SubType

string

データソースのサブタイプ。このパラメーターは、タイプにサブタイプが含まれるシナリオで使用されます。次のタイプとサブタイプがサポートされています。

  • タイプ: rds

  • サブタイプ: mysql、sqlserver、postgresql。

mysql

GmtModified

string

データソースが最後に変更済みになった時間。例: 2021 年 3 月 17 日 16:09:32。

Mar 17, 2021 4:09:32 PM

EnvType

integer

データソースが使用される環境。有効な値:

  • 0: 開発環境

  • 1: 本番環境

1

ConnectStatus

integer

データソースのステータス。有効な値:

  • 1: データソースは正常です。

  • 2: データソースは無効です。

1

Sequence

integer

データソースのソートに使用されるフィールド。データソースは、このパラメーターの値に基づいて降順でソートされます。

300

Description

string

データソースの説明。

a connection

GmtCreate

string

データソースが作成された時間。例: 2021 年 3 月 17 日 16:09:32。

Mar 17, 2021 4:09:32 PM

DefaultEngine

boolean

データソースに関連付けられているコンピュートエンジンが、同じタイプのデータソースで使用されるデフォルトのコンピュートエンジンであるかどうかを示します。

false

Shared

boolean

データソースが共有データソースであるかどうかを示します。

false

Operator

string

データソースを最後に変更した Alibaba Cloud アカウントの ID。

193543050****

Name

string

データソースの名前。

abc

Content

string

データソースの詳細。一般的なデータソースの詳細の例:

  • odps

{
  "accessId": "xssssss",
  "accessKey": "xsaxsaxsa",
  "authType": 2,
  "エンドポイント": "http://service.odps.aliyun.com/api",
  "プロジェクト": "xsaxsax",
  "タグ": "public"
}
  • mysql

{
  "データベース": "xsaxsa",
  "instanceName": "rm-xsaxsa",
  "password": "xsaxsa",
  "rdsオーナーID": "xasxsa",
  "リージョンID": "cn-shanghai",
  "タグ": "rds",
  "ユーザー名": "xsaxsa"
}
  • rds

{
  "configType": 1,
  "タグ": "rds",
  "データベース": "xsaxsa",
  "ユーザー名": "xsaxsa",
  "password": "xssaxsa$32050",
  "instanceName": "rm-xsaxs",
  "rdsオーナーID": "11111111"
}
  • oss

{
  "accessId": "sssssxx",
  "accessKey": "xsaxaxsaxs",
  "バケット": "xsa-xs-xs",
  "エンドポイント": "http://oss-cn-shanghai.aliyuncs.com",
  "タグ": "public"
}
  • sqlserver

{
  "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",
  "password": "sdasda$fs",
  "タグ": "public",
  "ユーザー名": "sxaxacdacdd"
}
  • polardb

{
  "clusterId": "pc-sdadsadsa",
  "データベース": "dsadsadsa",
  "オーナーID": "121212122",
  "password": "sdasdafssa",
  "リージョン": "cn-shanghai",
  "タグ": "polardb",
  "ユーザー名": "asdadsads"
}
  • oracle

{
  "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",
  "password": "sxasaxsa",
  "タグ": "public",
  "ユーザー名": "sasfadfa"
}
  • mongodb

{
  "address": "[\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\"]",
  "データベース": "admin",
  "password": "sadsda@",
  "タグ": "public",
  "ユーザー名": "dsadsadas"
}
  • emr

{
  "accessId": "xsaxsa",
  "emrClusterId": "C-dsads",
  "emrResourceQueueName": "デフォルト",
  "emrエンドポイント": "emr.aliyuncs.com",
  "accessKey": "dsadsad",
  "emrUserId": "224833315798889783",
  "name": "sasdsadsa",
  "emrAccessMode": "simple",
  "リージョン": "cn-shanghai",
  "authType": "2",
  "emrプロジェクトID": "FP-sdadsad"
}
  • postgresql

{
  "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",
  "password": "sdadsads",
  "タグ": "public",
  "ユーザー名": "sdsasda"
}
  • analyticdb_for_mysql

{
  "instanceId": "am-sadsada",
  "データベース": "xsxsx",
  "ユーザー名": "xsxsa",
  "password": "asdadsa",
  "接続文字列": "am-xssxsxs.ads.aliyuncs.com:3306"
}
  • hybriddb_for_postgresql

{
  "接続文字列": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",
  "データベース": "xsaxsaxas",
  "password": "xsaxsaxsa@11",
  "instanceId": "gp-xsaxsaxsa",
  "ポート": "541132",
  "オーナーID": "xsaxsaxsas",
  "ユーザー名": "sadsad"
}
  • holo

{
  "accessId": "xsaxsaxs",
  "accessKey": "xsaxsaxsa",
  "データベース": "xsaxsaxsa",
  "instanceId": "xsaxa",
  "タグ": "aliyun"
}
  • kafka

{
  "instanceId": "xsax-cn-xsaxsa",
  "リージョンID": "cn-shanghai",
  "タグ": "aliyun",
  "オーナーID": "1212121212112"
}

{\"database\":\"xxx\",\"instanceName\":\"xxx\",\"password\":\"xxx\",\"rdsOwnerId\":\"xxx\",\"tag\":\"rds\",\"username\":\"xxx\"}

Id

integer

データソースの ID。

1

BindingCalcEngineId

integer

データソースが関連付けられているコンピュートエンジンの ID。

123

TenantId

integer

テナントの ID。

1234567

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "0bc14115159376359****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 3,
    "Connections": [
      {
        "Status": 1,
        "ConnectionType": "mysql",
        "ProjectId": 123,
        "SubType": "mysql",
        "GmtModified": "Mar 17, 2021 4:09:32 PM",
        "EnvType": 1,
        "ConnectStatus": 1,
        "Sequence": 300,
        "Description": "a connection",
        "GmtCreate": "Mar 17, 2021 4:09:32 PM",
        "DefaultEngine": false,
        "Shared": false,
        "Operator": "193543050****",
        "Name": "abc",
        "Content": "{\\\"database\\\":\\\"xxx\\\",\\\"instanceName\\\":\\\"xxx\\\",\\\"password\\\":\\\"xxx\\\",\\\"rdsOwnerId\\\":\\\"xxx\\\",\\\"tag\\\":\\\"rds\\\",\\\"username\\\":\\\"xxx\\\"}",
        "Id": 1,
        "BindingCalcEngineId": 123,
        "TenantId": 1234567
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid.Tenant.ConnectionNotExists The connection does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist.
400 Invalid.Tenant.UserNotInProject The user is not in the project.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant.

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

変更履歴

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