イメージのリストを取得します。
操作説明
この API を使用するには、DataWorks Basic Edition 以降のバージョンが必要です。
この API を使用する前に、サービスリンクロール AliyunServiceRoleForDataWorks が作成されていることを確認してください。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Name |
string |
任意 |
イメージの名前。このパラメーターはあいまい検索に使用されます。 |
image |
| Statuses |
array |
任意 |
照会するイメージのステータス。 |
|
|
string |
任意 |
イメージのステータス。有効な値：
|
Enabled |
|
| Stages |
array |
任意 |
照会するリリースステージ。 |
|
|
string |
任意 |
リリースステージ。有効な値：
|
Published |
|
| Accessibility |
string |
任意 |
イメージの可視性。有効な値：
|
Public |
| ProjectIds |
array |
任意 |
ワークスペース ID。 |
|
|
integer |
任意 |
ワークスペース ID。 |
10001 |
|
| SupportedModules |
array |
任意 |
サポートされているモジュール。 |
|
|
string |
任意 |
サポートされているモジュール。有効な値：
|
Scheduler |
|
| SupportedTaskTypes |
array |
任意 |
サポートされているタスクタイプ。 |
|
|
string |
任意 |
サポートされているタスクタイプ。有効な値：
|
Shell |
|
| ProviderTypes |
array |
任意 |
プロバイダータイプ。 |
|
|
string |
任意 |
イメージのプロバイダータイプ。有効な値：
|
ACR |
|
| PageSize |
integer |
任意 |
各ページで返すエントリ数。 |
10 |
| PageNumber |
integer |
任意 |
ページ番号。 |
1 |
| SortBy |
string |
任意 |
結果のソートフィールドと順序。フォーマットは
|
CreatedTime Desc |
| SearchAll |
boolean |
任意 |
すべてのイメージを検索するかどうかを示します。 |
|
| Official |
boolean |
任意 |
公式イメージのみを返すかどうかを示します。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ。 |
||
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| PagingInfo |
object |
ページネーション情報。 |
|
| ImageList |
array<object> |
返されたイメージの詳細。 |
|
|
array<object> |
イメージの詳細。 |
||
| Id |
string |
イメージ ID。 |
Custom_image_xxxx_xxxx |
| Name |
string |
イメージ名。 |
dataworks_image |
| Version |
string |
イメージバージョン。 |
1 |
| Description |
string |
イメージの説明。 |
Test image created by xxx |
| Creator |
string |
イメージを作成したユーザーの ID。 |
123 |
| Modifier |
string |
イメージを最後に変更したユーザーの ID。 |
123 |
| CreatedTime |
integer |
イメージの作成時間。64 ビットのタイムスタンプで提供されます。 |
1727055811000 |
| LastModifiedTime |
integer |
イメージの最終更新時間。64 ビットのタイムスタンプで提供されます。 |
1727055811000 |
| Official |
boolean |
イメージが公式イメージかどうかを示します。 |
true |
| Accessibility |
string |
イメージの可視性。有効な値：
|
Public |
| Status |
string |
イメージのステータス。有効な値：
|
Available |
| PublishStage |
string |
イメージのリリースステージ。有効な値：
|
Published |
| Supported |
object |
サポートされているモジュールとタスクタイプ。 |
|
| Module |
string |
サポートされているモジュール。有効な値：
|
Scheduler |
| TaskTypes |
array |
サポートされているタスクタイプのリスト。 |
|
|
string |
サポートされているタスクタイプ。有効な値：
|
Shell |
|
| IsDefault |
boolean |
イメージがデフォルトのイメージかどうかを示します。 |
false |
| EnableSyncMaxCompute |
boolean |
MaxCompute との同期が有効になっているかどうかを示します。 |
false |
| ProviderType |
string |
イメージプロバイダーのタイプ。有効な値：
|
ACR |
| ProviderImageId |
string |
プロバイダーからのイメージ ID。 |
acr_image_id |
| ImageUri |
string |
イメージ URI。 |
registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag |
| Namespace |
string |
名前空間。 |
namespace |
| Size |
string |
イメージサイズ。 |
1GB |
| AcrInstanceId |
string |
ACR インスタンス ID。 |
cri-xxx |
| ImageTag |
string |
イメージタグ。 |
v1.0.0 |
| RepositoryName |
string |
リポジトリ名。 |
repo_name |
| ImageVpcUri |
string |
イメージ VPC URI。 |
registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag |
| AcrEndpoint |
string |
ACR エンドポイント。 |
registry.cn-hangzhou.aliyuncs.com |
| AcrAssociatedVpcId |
string |
ACR インスタンスに関連付けられている VPC の ID。 |
vpc-xxx |
| BuildConfig |
object |
イメージのビルド構成。 |
|
| BuildType |
string |
ビルドタイプ。 |
PackageInstallation |
| PackageInstallationScripts |
array<object> |
プレインストールスクリプトのリスト。 |
|
|
object |
プレインストールスクリプト。 |
||
| Type |
string |
スクリプトタイプ。 |
Python3 |
| Content |
string |
スクリプトのコンテンツ。複数のパッケージ名を指定する場合は、カンマで区切ります。 |
requests |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
ページサイズ。 |
10 |
| TotalCount |
integer |
エントリの総数。 |
10 |
| RequestId |
string |
リクエスト ID。この ID を使用して、ログの検索や問題のトラブルシューティングを行います。 |
6A6CBE87-9F91-1323-B680-E7A7065XXXXX |
例
成功レスポンス
JSONJSON
{
"Success": true,
"PagingInfo": {
"ImageList": [
{
"Id": "Custom_image_xxxx_xxxx",
"Name": "dataworks_image",
"Version": "1",
"Description": "Test image created by xxx",
"Creator": "123",
"Modifier": "123",
"CreatedTime": 1727055811000,
"LastModifiedTime": 1727055811000,
"Official": true,
"Accessibility": "Public",
"Status": "Available",
"PublishStage": "Published",
"Supported": {
"Module": "Scheduler",
"TaskTypes": [
"Shell"
]
},
"IsDefault": false,
"EnableSyncMaxCompute": false,
"ProviderType": "ACR",
"ProviderImageId": "acr_image_id",
"ImageUri": "registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag",
"Namespace": "namespace",
"Size": "1GB",
"AcrInstanceId": "cri-xxx",
"ImageTag": "v1.0.0",
"RepositoryName": "repo_name",
"ImageVpcUri": "registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag",
"AcrEndpoint": "registry.cn-hangzhou.aliyuncs.com",
"AcrAssociatedVpcId": "vpc-xxx",
"BuildConfig": {
"BuildType": "PackageInstallation",
"PackageInstallationScripts": [
{
"Type": "Python3",
"Content": "requests"
}
]
}
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 10
},
"RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。