查詢所有項目(Project)的信息,包含基礎信息,數據集(Dataset)和文件相關的統計信息等。
接口說明
支持分頁查看返回數據:分頁查詢首頁時,僅需設置 MaxResults 以限制返回信息的條目數,返回結果中的 NextToken 將作為查詢后續頁的憑證。查詢后續頁時,將 NextToken 參數設置為上一次返回結果中獲取到的 NextToken 作為查詢憑證,并設置 MaxResults 限制返回條目數。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
imm:ListProjects | list |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MaxResults | long | 否 | 返回項目的最大個數,取值范圍為 0~200。不設置此參數或者設置為 0 時,則默認值為 100。 | 100 |
NextToken | string | 否 | 查詢憑證(Token),取值為上一次 API 調用返回的 NextToken 參數值。從 NextToken 開始按字典序返回項目信息列表。第一次調用此接口時,設置為空。 | MTIzNDU2Nzg6aW1tdGVzdDAx |
Prefix | string | 否 | 列出指定前綴的項目,長度限制為 0~128 字符。 | immtest |
Tag | array<object> | 否 | 標簽列表 | |
object | 否 | 標簽信息 | ||
Key | string | 否 | 標簽鍵 | TestKey |
Value | string | 否 | 標簽值 | TestValue |
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "MTIzNDU2Nzg6aW1tdGVzdDAx",
"Projects": [
{
"ProjectName": "immtest",
"ServiceRole": "AliyunIMMDefaultRole",
"TemplateId": "Official:AllFunction",
"CreateTime": "2021-06-29T14:50:13.011643661+08:00",
"UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
"Description": "測試項目",
"ProjectQueriesPerSecond": 100,
"EngineConcurrency": 100,
"ProjectMaxDatasetCount": 1000000000,
"DatasetMaxBindCount": 10,
"DatasetMaxFileCount": 100000000,
"DatasetMaxEntityCount": 10000000000,
"DatasetMaxRelationCount": 100000000000,
"DatasetMaxTotalFileSize": 90000000000000000,
"DatasetCount": 5,
"FileCount": 10,
"TotalFileSize": 100000,
"Tags": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
}
],
"RequestId": "4A7A2D0E-D8B8-4DA0-8127-EB32C660"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-23 | OpenAPI 入參發生變更 | 查看變更詳情 |
2021-06-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |