ListProjects - 擷取專案列表 - MaxCompute

擷取MaxCompute專案列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

odps:ListProjects

list

Project

acs:odps:{#regionId}:{#accountId}:projects/*

無

請求文法

GET /api/v1/projects HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
tenantId	string	否	租戶 ID。可以通過登入 MaxCompute 控制台，在左側導覽列選擇租戶管理>租戶屬性查看。	5495****3697
region	string	否	地區 ID。	cn-beijing
quotaNickName	string	否	Quota 暱稱（可通過登入 MaxCompute 控制台，在左側導覽列選擇工作區>配額（Quota）管理查看擷取）。	os_PayAsYouGoQuota
quotaName	string	否	Quota 名稱（系統自動產生，可通過登入 MaxCompute 控制台，在左側導覽列選擇工作區>配額（Quota）管理查看擷取）。	aliyun_5495***3697
prefix	string	否	限定返回的資源名稱，名稱必須以 Prefix 作為首碼，例如 Prefix 是 a，則返回的資源名均是以 a 開始的。	a
marker	string	否	設定結果從 marker 之後按字母排序的第一個開始返回。	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	否	每頁返回的最大結果數，預設為 10。	10
saleTags	string	否	預設計算 Quota 的執行個體 ID 與付費類型。	{ "resourceId": "b7afb7d1-**--**-c393669c307b", "resourceType": "PayAsYouGo" }
type	string	否	項目類型。取值： managed：內部專案。 external：外部項目。	managed
listSystemCatalog	boolean	否	是否列出內建SYSTEM_CATALOG專案，用於提供專案中繼資料及使用歷史資料等資訊，詳細請參考 Information Schema功能。枚舉值： true : 列出 false : 不列出	true

返回參數

名稱	類型	描述	樣本值
	object	請求返回參數。
requestId	string	請求 ID。	0b16399216671970335563173e2340
data	object	請求返回結果。
projects	array<object>	專案列表。
	array<object>	專案資訊。
name	string	專案名稱。	odps_project
owner	string	專案 owner 帳號資訊。	ALIYUN$odps****@aliyunid.com
type	string	項目類型。取值： managed：內部專案。 external：外部項目。	managed
comment	string	專案描述。	BI_Analysis
defaultQuota	string	預設計算 Quota。用於實現計算資源分派。不指定計算 Quota 的情況下，該專案發起的作業將消耗預設 Quota 資源。更多計算資源使用請參見計算資源-Quota 使用。	os_PayAsYouGoQuota
status	string	專案狀態。取值： AVAILABLE：正常 READONLY：唯讀 FROZEN：凍結 DELETING：刪除中	AVAILABLE
costStorage	string	儲存總量。查看專案當前儲存大小，此儲存量與計量口徑一致，即按 Project 採集壓縮後的邏輯儲存大小。	16489027
regionId	string	地區 ID。	cn-beijing
createdTime	integer	建立時間。	1704380838000
properties	object	專案基礎屬性。
timezone	string	專案時區，即為`odps.sql.timezone`屬性。	Asia/Shanghai
retentionDays	integer	備份資料的保留天數。在此期間，您可以將目前的版本恢複至任意一個備份的資料版本。取值範圍為[0,30]，預設值為 1，0 代表關閉備份功能。	1
allowFullScan	boolean	專案空間是否允許全表掃描。全表掃描會佔用大量資源，為提升處理效率，預設關閉該功能。	false
typeSystem	string	資料類型版本。取值： 1：1.0 版本 2：2.0 版本 hive：hive 相容類型三種資料類型版本的區別請參見資料類型版本說明。	2
enableDecimal2	boolean	專案是否開啟 MaxCompute 2.0 的 Decimal 資料類型。	true
sqlMeteringMax	string	單 SQL 消費的最高閾值。單位：掃描量（GB）*複雜度。	1500
tableLifecycle	object	表的生命週期屬性。
type	string	生命週期類型。取值： mandatory：Lifecycle 子句為必選設定，使用者必須設定表的生命週期。 optional：建立表時，Lifecycle 子句為可選設定，如果不設定表的生命週期，則該表永遠有效。 inherit：建立表時，如果不設定表的生命週期，則該表的生命週期為 odps.table.lifecycle.value 的值。	optional
value	string	表的生命週期，單位為：天。取值範圍為 1~37231，預設值為 37231。	37231
encryption	object	儲存加密屬性。
enable	boolean	專案是否開啟資料加密功能。更多資料加密資訊，請參見儲存加密。	true
algorithm	string	資料加密演算法：密鑰支援的密碼編譯演算法，包含 AES256、AESCTR 和 RC4。	AES256
key	string	資料加密使用的密鑰類型，包含預設密鑰（MaxCompute Default Key）和內建密鑰（BYOK）。預設密鑰（MaxCompute Default Key）是 MaxCompute 內部建立的預設密鑰。	dafault
tunnelQuota	string	專案綁定的 Data Transmission Service資源群組。 Default（Data Transmission Service共用資源組）：該專案不允許使用Data Transmission Service（訂用帳戶）資源群組。不管開啟成預設Data Transmission Service資源群組取值是什麼，該專案預設提交的Data Transmission Service會自動使用 Default 資源群組。 Data Transmission Service（訂用帳戶）資源群組：該專案允許使用Data Transmission Service（訂用帳戶）資源群組。	Default
enableTunnelQuotaRoute	boolean	是否開啟Data Transmission Service資源群組路由。 true：表示該專案預設提交的資料轉送任務會使用繫結資料傳輸服務資源群組。 false：表示該專案預設提交的資料轉送任務會使用Data Transmission Service共用資源組。	true
externalProjectProperties	object	外部項目屬性。
isExternalCatalogBound	string	是否為湖倉一體 2.0外部項目。	true
securityProperties	object	許可權屬性。
usingAcl	boolean	是否使用 ACL 許可權控制功能，預設為使用狀態。	true
usingPolicy	boolean	是否使用 Policy 許可權控制功能，預設為使用狀態。	true
objectCreatorHasAccessPermission	boolean	是否允許對象建立者擁有對象的存取權限，預設為允許狀態。	true
objectCreatorHasGrantPermission	boolean	是否允許對象建立者擁有對象的授權許可權，預設為允許狀態。	true
labelSecurity	boolean	是否使用 Label 許可權控制功能，預設為不使用狀態。	false
enableDownloadPrivilege	boolean	是否使用 Download 許可權控制功能，預設為不使用狀態。	false
projectProtection	object	資料保護機制屬性。
protected	boolean	是否開啟專案的資料保護機制，禁止或允許資料流出專案，預設為不開啟狀態。	true
exceptionPolicy	string	如選擇開啟專案空間資料保護，允許設定例外或受信任專案，指定使用者將指定對象的資料流出至指定專案，所有符合 Exception Policy 中描述的情形都可以打破資料保護機制。	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
ipWhiteList	object	IP 白名單。
ipList	string	公網和雲產品互連網絡 IP 白名單。說明如果只配置公網和雲產品互連網絡 IP 白名單，則公網和雲產品互連網絡訪問受配置限制，VPC 網路訪問全部禁止。	10.88.111.3
vpcIpList	string	VPC 網路 IP 白名單。說明如果只配置 VPC 網路 IP 白名單，則 VPC 網路訪問受配置限制，公網和雲產品互連網絡訪問全部禁止。	10.88.111.3
saleTag	object	預設計算 Quota 的執行個體 ID 與付費類型。
resourceId	string	預設計算 Quota 的執行個體 ID。	b7afb7d1-**--**-c393669c307b
resourceType	string	預設計算 Quota 的付費類型。	PayAsYouGo
threeTierModel	boolean	是否支援按 Schema 儲存。 MaxCompute 支援 Schema，處於 Project 下，Table、Resource、UDF 上的對象，對 Table、Resource、UDF 進行歸類。一個 Project 下可以有多個 Schema。詳情請參見 Schema 操作。枚舉值： true : 支援 false : 不支援	true
marker	string	設定結果從 marker 之後按字母排序的第一個開始返回。	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	每頁返回的最大結果數。	10
NextToken	string	分頁標識，當前介面僅支援連續翻頁。傳回值 nextToken 非空代表還有剩餘資料。把 nextToken 作為參數繼續查詢會獲得下一頁。	AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

樣本

正常返回樣本

JSON格式

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com\n",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota\n",
        "status": "AVAILABLE",
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai\n",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231\n"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "enableTunnelQuotaRoute": true,
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "protected": true,
            "exceptionPolicy": "{\n      \"Version\": \"1\",\n      \"Statement\": [\n            {\n                  \"Effect\": \"Allow\",\n                  \"Principal\": \"\",\n                  \"Action\": [\n                        \"odps:[, , ...]\"\n                  ],\n                  \"Resource\": \"acs:odps:*:\",\n                  \"Condition\": {\n                        \"StringEquals\": {\n                              \"odps:TaskType\": [\n                                    \"\"\n                              ]\n                        }\n                  }\n            }\n      ]\n}"
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b\n",
          "resourceType": "PayAsYouGo\n"
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。