ListDatasets API を呼び出してワークスペース内のデータセットをリスト - PAI - Alibaba Cloud -

ワークスペース内のデータセットをリストアップします。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paidataset:ListDatasets

list

*All Resource

*

なし

リクエスト構文

GET /api/v1/datasets HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページングクエリのページ番号。1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりに返すデータセットの数。デフォルト値は 10 です。	10
Order	string	任意	`SortBy` パラメーターに基づく結果のソート順。デフォルト値は `ASC` です。 `ASC`：昇順。 `DESC`：降順。列挙値: ASC : ASC DESC : DESC	ASC
Name	string	任意	データセット名。あいまい検索がサポートされています。	myName
Properties	string	任意	データセットのプロパティ。複数のプロパティを指定するには、コンマ (,) で区切ります。有効値： `DIRECTORY`：フォルダ。 `FILE`：ファイル。列挙値: DIRECTORY : DIRECTORY FILE : FILE	FILE
DataSourceTypes	string	任意	データソースのタイプ。複数のタイプを指定するには、コンマ (,) で区切ります。有効値： `NAS`：データソースは NAS です。 `OSS`：データソースは OSS です。列挙値: NAS : NAS OSS : OSS	OSS
DataTypes	string	任意	データセットのデータの型。複数のデータの型を指定するには、コンマ (,) で区切ります。有効値： `VIDEO`：ビデオ。 `COMMON`：一般。 `TEXT`：テキスト。 `PIC`：画像。 `AUDIO`：オーディオ。列挙値: VIDEO : VIDEO COMMON : COMMON TEXT : TEXT PIC : PIC AUDIO : AUDIO	COMMON,TEXT
SourceId	string	任意	ソース ID。このパラメーターの値は、`SourceTypes` の値によって異なります。 `SourceTypes` が `USER` の場合、`SourceId` にカスタム値を指定できます。 `SourceTypes` が `ITAG` の場合、`SourceId` は iTAG タスクの ID です。 `SourceTypes` が `PAI_PUBLIC_DATASET` の場合、このパラメーターはデフォルトで空です。	d-rbvg5wzljzjhc9ks92
SourceTypes	string	任意	ソースタイプ。複数のタイプを指定するには、コンマ (,) で区切ります。列挙値: PAI_PUBLIC_DATASET : PAI_PUBLIC_DATASET ITAG : ITAG USER : USER	USER,ITAG
WorkspaceId	string	任意	データセットが含まれるワークスペースの ID。ワークスペース ID の取得方法については、「ListWorkspaces」をご参照ください。このパラメーターが指定されていない場合、デフォルトのワークスペースが使用されます。デフォルトのワークスペースが存在しない場合は、エラーが返されます。	324**
Label	string	任意	データセットをフィルターするために使用されるラベル。この操作では、ラベルキーまたは値に指定された文字列が含まれるデータセットが返されます。	test
Provider	string	任意	データセットのプロバイダー。このパラメーターを `pai` に設定して、PAI プラットフォーム上のパブリックデータセットをクエリします。	pai
SourceDatasetId	string	任意	iTAG アノテーションセットのソースデータセット ID。	d-rcdg3wxxxxxhc5jk87
SortBy	string	任意	ソートフィールド。列挙値: DataSourceType : DataSourceType DataType : DataType GmtCreateTime : GmtCreateTime GmtModifiedTime : GmtModifiedTime	GmtCreateTime
ShareScope	string	任意	共有データセットのフィルター。 `TO_ME`：自分と共有されているデータセットのみを返します。 `BY_ME`：自分が他のユーザーと共有しているデータセットのみを返し、共有設定の詳細を表示します。このパラメーターを省略するか空のままにすると、この操作は、自分と共有されているデータセットを含む、現在のワークスペース内のすべてのデータセットを返します。列挙値: TO_ME : TO_ME BY_ME : BY_ME	BY_ME
Edition	string	任意	データセットのエディション。有効値： `BASIC`：Basic エディション。ファイルメタデータ管理をサポートしていません。 `ADVANCED`：Advanced エディション。このエディションは OSS データセットでのみサポートされています。各バージョンは最大 100 万ファイルのメタデータを管理できます。 `LOGICAL`：Logical エディション。このエディションは OSS データセットでのみサポートされており、ほとんどのユースケースに適しています。各バージョンは最大 100 万ファイルのメタデータを管理できます。このエディションでは SDK を使用する必要があります。列挙値: LOGICAL : LOGICAL BASIC : BASIC ADVANCED : ADVANCED	BASIC
Accessibility	string	任意	データセットの可視性を指定します。 `PUBLIC`：データセットはパブリックアクセス可能です。 `PRIVATE`：データセットはプライベートアクセス可能です。列挙値: PUBLIC : PUBLIC PRIVATE : PRIVATE	PRIVATE
DatasetIds	string	任意	データセット 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",
        "Labels": [
          {
            "Key": "env",
            "Value": "test"
          }
        ],
        "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}"
      },
      "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": [
        ""
      ]
    }
  ],
  "TotalCount": 15
}

エラーコード

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

変更履歴

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