アプリケーションの基本情報を照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
ページ番号。ページは 1 から始まります。デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
1ページあたりのエントリ数。デフォルト値：10。最大値：100。 |
10 |
| ProjectIdList |
string |
必須 |
アプリケーションの基本情報を照会する基準となるワークスペースの ID。複数の ID を指定できます。コンマ (,) で区切ります。少なくとも 1 つのワークスペース ID を指定する必要があります。最大 50 個のワークスペース ID を指定できます。 |
10000,100001 |
| TenantId |
integer |
任意 |
テナント ID。テナント ID を取得するには、次の手順に従ってください。DataWorks コンソールにログインします。ご利用のワークスペースを見つけて、DataStudio ページに移動します。DataStudio ページで、右上のログインユーザー名をクリックし、メニューセクションの [ユーザー情報] をクリックします。 |
100002 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP ステータスコード。 |
200 |
| RequestId |
string |
リクエスト ID。 |
0000-ABCD-EFG*** |
| ErrorMessage |
string |
エラーメッセージ。 |
正常 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| ErrorCode |
string |
エラーコード。 |
0 |
| Data |
object |
返されたデータ。 |
|
| PageNumber |
integer |
ページ番号。このパラメーターの値は、リクエストの PageNumber パラメーターの値と同じです。 |
1 |
| PageSize |
integer |
1ページあたりのエントリ数。デフォルト値：10。最大値：100。 |
10 |
| TotalCount |
integer |
返されたエントリの総数。 |
100 |
| Applications |
array<object> |
アプリケーションの基本情報。 |
|
|
object |
|||
| ApplicationName |
string |
アプリケーションの名前。 |
我的应用 |
| ApplicationId |
integer |
アプリケーション ID。 |
20000 |
| ProjectId |
integer |
ワークスペース ID。 |
10000 |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG***",
"ErrorMessage": "正常",
"Success": true,
"ErrorCode": "0",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Applications": [
{
"ApplicationName": "我的应用",
"ApplicationId": 20000,
"ProjectId": 10000
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。