指定されたワークスペース内のデータセットのリストを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
paidataset:ListDatasets |
list |
*すべてのリソース。
|
なし | なし |
リクエスト構文
GET /api/v1/datasets HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
データセットリストのページ番号。最小値: 1。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリのページサイズ。デフォルト値: 10。 |
10 |
| Order |
string |
任意 |
ページングクエリにおける指定されたソートフィールドのソート順。デフォルト値: ASC。
列挙値:
|
ASC |
| Name |
string |
任意 |
データセット名。データセット名に基づくあいまい一致がサポートされています。 |
myName |
| Properties |
string |
任意 |
データセットのプロパティ。複数の値はカンマ (,) で区切ります。有効な値:
列挙値:
|
FILE |
| DataSourceTypes |
string |
任意 |
データソースタイプ。複数の値はカンマ (,) で区切ります。有効な値:
列挙値:
|
OSS |
| DataTypes |
string |
任意 |
データセットのデータタイプ。複数の値はカンマ (,) で区切ります。有効な値:
列挙値:
|
COMMON,TEXT |
| SourceId |
string |
任意 |
データソース ID。
|
d-rbvg5wzljzjhc9ks92 |
| SourceTypes |
string |
任意 |
ソースタイプ。複数の値はカンマ (,) で区切ります。 列挙値:
|
USER,ITAG |
| WorkspaceId |
string |
任意 |
データセットが存在するワークスペースの ID。ワークスペース ID の取得方法については、「 ListWorkspaces 」をご参照ください。 このパラメーターを指定しない場合、デフォルトのワークスペースが使用されます。デフォルトのワークスペースが存在しない場合、エラーが返されます。 |
324** |
| Label |
string |
任意 |
データセットリストをフィルター処理するために使用されるデータセットラベル。ラベルのキーまたは値に指定された文字列が含まれるデータセットが返されます。 |
test |
| Provider |
string |
任意 |
データセットプロバイダー。値 "pai" は、データセットが PAI プラットフォームのパブリックデータセットであることを示します。 |
pai |
| SourceDatasetId |
string |
任意 |
iTAG アノテーションセットのソースデータセット ID。 |
d-rcdg3wxxxxxhc5jk87 |
| SortBy |
string |
任意 |
結果をソートするためのフィールド。 列挙値:
|
GmtCreateTime |
| ShareScope |
string |
任意 |
データセットの共有フィルター:
列挙値:
|
BY_ME |
| Edition |
string |
任意 |
データセットのエディション。有効な値:
列挙値:
|
BASIC |
| Accessibility |
string |
任意 |
データセットの可視性。
列挙値:
|
PRIVATE |
| DatasetIds |
string |
任意 |
データセット ID。カンマ (,) で区切って複数のデータセット ID を指定できます。 |
d-rcdg3wxxxxxhc5jk87 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディ。 |
||
| RequestId |
string |
リクエスト ID。 |
5A14FA81-DD4E-******-6343FE44B941 |
| Datasets |
array |
データセットのリスト。 |
|
| Dataset |
データセット。 |
||
| TotalCount |
integer |
返されたエントリの総数。 |
15 |
例
成功レスポンス
JSONJSON
{
"RequestId": "5A14FA81-DD4E-******-6343FE44B941",
"Datasets": [
{
"DatasetId": "d-c0h44g3****j8o4348",
"UserId": "2485765****023475",
"OwnerId": "1631044****3440",
"Name": "myName",
"DataSourceType": "NAS",
"Uri": "nas://09f****f2.cn-hangzhou/",
"GmtCreateTime": "2021-01-21T17:12:35.232Z",
"GmtModifiedTime": "2021-01-21T17:12:35.232Z",
"DataType": "COMMON",
"Property": "DIRECTORY",
"SourceType": "USER",
"SourceId": "jdnhf***fnrimv",
"Description": "This is a description of a dataset.",
"WorkspaceId": "478**",
"Options": "{\n \"mountPath\": \"/mnt/data/\"\n}",
"Accessibility": "PRIVATE",
"ProviderType": "Ecs",
"SourceDatasetId": "d-bvfasdfxxxxj8o411",
"SourceDatasetVersion": "v2",
"TagTemplateType": "text-classification",
"LatestVersion": {
"VersionName": "v1",
"GmtCreateTime": "2021-01-21T17:12:35.232Z",
"GmtModifiedTime": "2021-01-21T17:12:35.232Z",
"Property": "FILE",
"DataSourceType": "OSS",
"Uri": "OSS://xxx",
"Options": "{\n \"mountPath\": \"/mnt/data/\"\n}",
"SourceType": "USER",
"Description": "base model v1",
"SourceId": "d-65mrsr5fub4u74lej3",
"DataCount": 10000,
"DataSize": 10000,
"MountAccess": "RO",
"ImportInfo": "{\n \"region\": \"cn-wulanchabu\",\n \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n \"path\": \"/mnt\",\n \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n \"isVpcMount\": true\n}",
"DatasetTaskRamRole": "acs:ram::1234567890123456:role/role-name",
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"UserMetricsEndpoints": [
{
"Port": 0,
"Path": ""
}
]
},
"MountAccess": "RO RW",
"ImportInfo": "{\n \"region\": \"cn-wulanchabu\",\n \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n \"path\": \"/mnt\",\n \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n \"isVpcMount\": true\n}",
"Edition": "BASIC",
"IsShared": false,
"SharedFrom": {
"Status": "ACTIVE",
"SourceTenantId": "148***************115",
"SourceWorkspaceId": "33**19",
"TenantId": "153***************249",
"WorkspaceId": "42**2",
"IsSecureMode": true,
"SharedAt": "2025-08-27T12:23:58Z",
"ExpiresAt": "2026-08-27T12:23:58Z",
"AllowedMountAccessLevels": [
"RO"
],
"Extra": "{\"AllowExportModel\":false,\"AllowAccessDLCWebTerminal\":false,\"AllowAccessDLCFullLog\":false}"
},
"SharingConfig": {
"SharedTo": [
{
"Status": "ACTIVE",
"SourceTenantId": "148***************115",
"SourceWorkspaceId": "33**19",
"TenantId": "153***************249",
"WorkspaceId": "42**2",
"IsSecureMode": true,
"SharedAt": "2025-08-27T12:23:58Z",
"ExpiresAt": "2026-08-27T12:23:58Z",
"AllowedMountAccessLevels": [
"RO"
],
"Extra": "{\"AllowExportModel\":false,\"AllowAccessDLCWebTerminal\":false,\"AllowAccessDLCFullLog\":false}"
}
]
},
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"MountAccessReadWriteRoleIdList": [
"PAI.AlgoOperator"
],
"AccessibleRoleIdList": [
"PAI.AlgoOperator"
]
}
],
"TotalCount": 15
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。