獲取某個工作空間下的數據集列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
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 | 否 | 數據集標簽,用于過濾數據集列表。標簽 Key 或 Value 中,有指定字符串的,都會被過濾出來。 | test |
Provider | string | 否 | 數據集提供方。返回值為"pai"時表示該數據集為 PAI 平臺的公共數據集。 | pai |
SourceDatasetId | string | 否 | iTag 標注集的來源數據集 ID。 | d-rcdg3wxxxxxhc5jk87 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "5A14FA81-DD4E-******-6343FE44B941",
"Datasets": [
{
"DatasetId": "d-c0h44g3****j8o4348",
"UserId": "2485765****023475",
"OwnerId": "1631044****3440",
"Name": "myName",
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"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": "用于標注的數據。",
"WorkspaceId": "478**",
"Options": "{\n \"mountPath\": \"/mnt/data/\"\n}",
"Accessibility": "PRIVATE",
"ProviderType": "Ecs",
"SourceDatasetId": "d-bvfasdfxxxxj8o411",
"SourceDatasetVersion": "v2",
"TagTemplateType": "text-classification",
"LatestVersion": {
"VersionName": "v1",
"GmtCreateTime": "",
"GmtModifiedTime": "",
"Property": "FILE",
"DataSourceType": "OSS",
"Uri": "OSS://xxx",
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"Options": "",
"SourceType": "",
"Description": "",
"SourceId": "",
"DataCount": 0,
"DataSize": 0
}
}
],
"TotalCount": 15
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-18 | OpenAPI 入參發生變更 | 查看變更詳情 |
2024-07-09 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2024-02-27 | OpenAPI 入參發生變更 | 查看變更詳情 |