DataWorks ワークスペースに追加されたデータソースを照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
データソースが属する DataWorks ワークスペースの ID です。ワークスペース ID を照会するには、ListProjects 操作を呼び出します。 |
1 |
| Name |
string |
任意 |
照会対象のデータソースの名前です。 |
test |
| DataSourceType |
string |
任意 |
データソースの種別です。有効な値は以下のとおりです。
|
rds |
| SubType |
string |
任意 |
データソースのサブタイプです。このパラメーターは、DataSourceType パラメーターが rds に設定されている場合のみ有効です。 DataSourceType パラメーターの値が rds の場合、このパラメーターの値は mysql、sqlserver、または postgresql のいずれかになります。 |
mysql |
| Status |
string |
任意 |
データソースのステータスです。有効な値は以下のとおりです。
|
ENABLED |
| EnvType |
integer |
任意 |
データソースが使用される環境です。有効な値は 0 および 1 です。0 は開発環境を示し、1 は本番環境を示します。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりの表示件数です。デフォルト値は 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 |
1 ページあたりの表示件数です。 |
20 |
| TotalCount |
integer |
データソースの合計件数です。 |
233 |
| DataSources |
array<object> |
データソースの一覧です。 |
|
|
object |
データソースの情報です。 |
||
| Status |
integer |
データソースのステータスです。有効な値は以下のとおりです。
|
1 |
| ProjectId |
integer |
データソースが属するワークスペースの ID です。 |
123 |
| SubType |
string |
データソースのサブタイプです。このパラメーターは、DataSourceType パラメーターが rds に設定されている場合のみ有効です。 |
mysql |
| GmtModified |
string |
データソースが最後に変更された時刻です。例:Mar 17, 2021 4:09:32 PM。 |
Mar 17, 2021 4:09:32 PM |
| EnvType |
integer |
データソースが使用される環境です。有効な値は以下のとおりです。
|
1 |
| ConnectStatus |
integer |
データソースの接続ステータスです。有効な値は以下のとおりです。
|
1 |
| Sequence |
integer |
データソースのシーケンス番号です。このパラメーターの値に基づいて、データソースは降順で並べられます。 |
300 |
| Description |
string |
データソースの説明です。 |
a connection |
| DataSourceType |
string |
データソースの種別です。有効な値は以下のとおりです。
|
rds |
| GmtCreate |
string |
データソースが作成された時刻です。例:Mar 17, 2021 4:09:32 PM。 |
Mar 17, 2021 4:09:32 PM |
| DefaultEngine |
boolean |
データソースに関連付けられたコンピュートエンジンが、同種のデータソースで使用されるデフォルトのコンピュートエンジンであるかどうかを示します。 |
false |
| Shared |
boolean |
データソースが共有データソースであるかどうかを示します。 |
false |
| Operator |
string |
データソースを最後に変更した Alibaba Cloud アカウントの ID です。 |
193543050**** |
| Name |
string |
データソースの名前です。 |
abc |
| Content |
string |
データ接続文字列です。このパラメーターの値は JSON 形式です。一般的なデータソースの接続文字列の例を以下に示します。
|
{"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": 1,
"PageSize": 20,
"TotalCount": 233,
"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.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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。