查詢MaxCompute專案的基本資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
odps:GetProject |
get |
*Project
|
無 | 無 |
請求文法
GET /api/v1/projects/{projectName} HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| projectName |
string |
是 |
專案名稱。 |
odps_project |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| verbose |
boolean |
否 |
是否帶有附加資訊(securityProperties, superAdmins) |
true |
| withStorageTierInfo |
boolean |
否 |
是否帶有附加資訊(properties.storageTierInfo) |
true |
| withQuotaProductType |
boolean |
否 |
是否帶有附加資訊(productType) |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
請求返回參數。 |
||
| data |
object |
請求返回結果。 |
|
| comment |
string |
專案描述。 |
BI_Analysis |
| costStorage |
string |
儲存總量。 查看專案目前儲存大小，此儲存量與計量口徑一致，即按 Project 採集壓縮後的邏輯儲存大小。 |
16489027 |
| createdTime |
integer |
建立時間。 |
1704380838000 |
| defaultQuota |
string |
預設計算 Quota。 用於實現運算資源分配。未指定計算 Quota 的情況下，該專案發起的作業將消耗預設 Quota 資源。更多運算資源使用請參閱 計算資源-Quota 使用。 |
os_PayAsYouGoQuota |
| ipWhiteList |
object |
IP 白名單。 |
|
| ipList |
string |
公網和雲端產品互連網路 IP 白名單。 說明
如果只設定公網和雲端產品互連網路 IP 白名單，則公網和雲端產品互連網路存取受設定限制，VPC 網路存取全部禁止。 |
10.88.111.3 |
| vpcIpList |
string |
VPC 網路 IP 白名單。 說明
如果只設定 VPC 網路 IP 白名單，則 VPC 網路存取受設定限制，公網和雲端產品互連網路存取全部禁止。 |
10.88.111.3 |
| name |
string |
專案名稱。 |
odps_project |
| owner |
string |
專案 owner 帳號資訊。 |
ALIYUN$odps****@aliyunid.com |
| productType |
string |
預設計算 Quota 的計費模式。 |
PayAsYouGo |
| properties |
object |
專案基礎屬性。 |
|
| allowFullScan |
boolean |
專案空間是否允許全表掃描。全表掃描會佔用大量資源，為提升處理效率，預設關閉該功能。 |
false |
| autoMvQuotaGb |
integer |
||
| elderTunnelQuota |
string |
專案綁定的資料傳輸服務資源群組父群組（無需關注）。 |
Default_p |
| enableAutoMv |
boolean |
||
| enableDataMasking |
boolean |
||
| enableDecimal2 |
boolean |
專案是否開啟 MaxCompute 2.0 的 Decimal 資料類型。 |
true |
| enableDr |
boolean |
||
| enableFdcCacheForce |
boolean |
是否強制開啟外部表快取。 |
true |
| enableTieredStorage |
boolean |
是否開啟 分層儲存。 |
true |
| enableTunnelQuotaRoute |
boolean |
是否開啟資料傳輸服務資源群組路由。
|
true |
| encryption |
object |
儲存加密屬性。 |
|
| algorithm |
string |
資料加密演算法：金鑰支援的加密演算法，包含 AES256、AESCTR 和 RC4。 |
AES256 |
| enable |
boolean |
專案是否需要開啟資料加密功能。更多資料加密資訊，請參閱 儲存加密。 |
true |
| key |
string |
資料加密使用的金鑰類型，包含預設金鑰（MaxCompute Default Key）和自帶金鑰（BYOK）。預設金鑰（MaxCompute Default Key）是 MaxCompute 內部建立的預設金鑰。 |
dafault |
| externalProjectProperties |
object |
外部專案屬性。 |
|
| externalCatalogId |
string |
||
| foreignServerName |
string |
||
| foreignServerType |
string |
||
| isExternalCatalogBound |
string |
是否為 湖倉一體 2.0外部專案。 |
true |
| tableFormat |
string |
||
| warehouse |
string |
||
| fdcQuota |
string |
外部表快取 Quota。 |
fdc_quota |
| retentionDays |
integer |
備份資料的保留天數。在此期間，您可以將目前版本復原至任意一個備份的資料版本。 取值範圍為 [0,30]，預設值為 1，0 代表關閉備份功能。 |
1 |
| sqlMeteringMax |
string |
單 SQL 消費的最高臨界值。 單位：掃描量（GB）*複雜度。 |
1500 |
| storageTierInfo |
object |
分層儲存資訊。 |
|
| projectBackupSize |
integer |
備份儲存大小。 |
86672917 |
| projectTotalSize |
integer |
總儲存用量。 |
56066037 |
| storageTierSize |
object |
分層儲存資訊。 |
|
| longTermSize |
integer |
長期儲存用量。 |
21764917 |
| lowFrequencySize |
integer |
低頻儲存用量。 |
767693 |
| standardSize |
integer |
標準儲存用量。 |
27649172 |
| tableLifecycle |
object |
資料表的生命週期屬性。 |
|
| type |
string |
生命週期類型。取值：
|
optional |
| value |
string |
資料表的生命週期，單位為：天。取值範圍為 1~37231，預設值為 37231。 |
37231 |
| tableLifecycleConfig |
object |
分層儲存生命週期規則屬性，設定後系統將基於該規則觸發分層儲存類型自動轉換。 |
|
| TierToLongterm |
object |
長期儲存標識。 |
|
| DaysAfterLastAccessGreaterThan |
integer |
距離資料最後存取時間超過多少天後自動設定，對應資料表或分區的 說明
若資料表或分區的 LastAccessTime 為空，則：
|
180 |
| DaysAfterLastModificationGreaterThan |
integer |
距離資料最後修改時間超過多少天後自動設定，對應資料表或分區的 |
180 |
| DaysAfterLastTierModificationGreaterThan |
integer |
距離上次轉換儲存類型的時間。 |
1 |
| TierToLowFrequency |
object |
低頻儲存標識。 |
|
| DaysAfterLastAccessGreaterThan |
integer |
定義距離資料最後存取時間超過多少天後自動設定，對應資料表或分區的 說明
若資料表或分區的 LastAccessTime 為空，則：
|
30 |
| DaysAfterLastModificationGreaterThan |
integer |
定義距離資料最後修改時間超過多少天後自動設定，對應資料表或分區的 |
30 |
| DaysAfterLastTierModificationGreaterThan |
integer |
距離上次轉換儲存類型的時間。 |
1 |
| timezone |
string |
專案時區，即為 |
Asia/Shanghai |
| tunnelQuota |
string |
專案綁定的 資料傳輸服務資源群組。
|
Default |
| typeSystem |
string |
資料類型版本。取值：
三種資料類型版本的區別請參閱 資料類型版本說明。 |
2.0 |
| regionId |
string |
區域 ID。 |
cn-beijing |
| saleTag |
object |
預設計算 Quota 的執行個體 ID 與付費類型。 |
|
| resourceId |
string |
預設計算 Quota 的執行個體 ID。 |
b7afb7d1-****-****-****-c393669c307b |
| resourceType |
string |
預設計算 Quota 的付費類型。 |
PayAsYouGo |
| securityProperties |
object |
權限屬性。 |
|
| enableDownloadPrivilege |
boolean |
是否使用 Download 權限控制功能，預設為不使用狀態。 |
false |
| enableNamespacePrivilege |
boolean |
開啟 IAM 權限。 |
|
| labelSecurity |
boolean |
是否使用 Label 權限控制功能，預設為不使用狀態。 |
false |
| objectCreatorHasAccessPermission |
boolean |
是否允許物件建立者擁有物件的存取權限，預設為允許狀態。 |
true |
| objectCreatorHasGrantPermission |
boolean |
是否允許物件建立者擁有物件的授權權限，預設為允許狀態。 |
true |
| projectProtection |
object |
資料保護機制屬性。 |
|
| exceptionPolicy |
string |
如選擇開啟專案空間資料保護，允許設定例外或受信任專案，指定使用者將指定物件的資料流出至指定專案，所有符合 Exception Policy 中描述的情形都可以打破資料保護機制。 |
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] } |
| protected |
boolean |
是否開啟專案的 資料保護機制，禁止或允許資料流出專案，預設為不開啟狀態。 |
true |
| usingAcl |
boolean |
是否使用 ACL 權限控制功能，預設為使用狀態。 |
true |
| usingPolicy |
boolean |
是否使用 Policy 權限控制功能，預設為使用狀態。 |
true |
| status |
string |
專案狀態。取值：
|
AVAILABLE |
| superAdmins |
array |
專案的 |
|
|
string |
專案的 |
RAM$odps****@aliyunid.com:RAM_USER |
|
| threeTierModel |
boolean |
是否支援按 Schema 儲存。 MaxCompute 支援 Schema，處於 Project 下，Table、Resource、UDF 上的物件，對 Table、Resource、UDF 進行歸類。一個 Project 下可以有多個 Schema。詳細資訊請參閱 Schema 操作。 |
true |
| type |
string |
專案類型。取值：
|
managed |
| errorCode |
string |
錯誤碼。 |
OBJECT_NOT_EXIST |
| errorMsg |
string |
錯誤資訊。 |
This object does not exist. |
| httpCode |
integer |
HTTP 狀態碼。
|
200 |
| requestId |
string |
請求 ID。 |
0b87b7b316643495896551555e855b |
樣本
正常返回樣本
JSON格式
{
"data": {
"comment": "BI_Analysis",
"costStorage": "16489027",
"createdTime": 1704380838000,
"defaultQuota": "os_PayAsYouGoQuota",
"ipWhiteList": {
"ipList": "10.88.111.3",
"vpcIpList": "10.88.111.3"
},
"name": "odps_project",
"owner": "ALIYUN$odps****@aliyunid.com",
"productType": "PayAsYouGo",
"properties": {
"allowFullScan": false,
"autoMvQuotaGb": 0,
"elderTunnelQuota": "Default_p",
"enableAutoMv": false,
"enableDataMasking": false,
"enableDecimal2": true,
"enableDr": false,
"enableFdcCacheForce": true,
"enableTieredStorage": true,
"enableTunnelQuotaRoute": true,
"encryption": {
"algorithm": "AES256",
"enable": true,
"key": "dafault"
},
"externalProjectProperties": {
"externalCatalogId": "",
"foreignServerName": "",
"foreignServerType": "",
"isExternalCatalogBound": "true",
"tableFormat": "",
"warehouse": ""
},
"fdcQuota": "fdc_quota",
"retentionDays": 1,
"sqlMeteringMax": "1500",
"storageTierInfo": {
"projectBackupSize": 86672917,
"projectTotalSize": 56066037,
"storageTierSize": {
"longTermSize": 21764917,
"lowFrequencySize": 767693,
"standardSize": 27649172
}
},
"tableLifecycle": {
"type": "optional",
"value": "37231"
},
"tableLifecycleConfig": {
"TierToLongterm": {
"DaysAfterLastAccessGreaterThan": 180,
"DaysAfterLastModificationGreaterThan": 180,
"DaysAfterLastTierModificationGreaterThan": 1
},
"TierToLowFrequency": {
"DaysAfterLastAccessGreaterThan": 30,
"DaysAfterLastModificationGreaterThan": 30,
"DaysAfterLastTierModificationGreaterThan": 1
}
},
"timezone": "Asia/Shanghai",
"tunnelQuota": "Default",
"typeSystem": "2.0"
},
"regionId": "cn-beijing",
"saleTag": {
"resourceId": "b7afb7d1-****-****-****-c393669c307b",
"resourceType": "PayAsYouGo"
},
"securityProperties": {
"enableDownloadPrivilege": false,
"enableNamespacePrivilege": false,
"labelSecurity": false,
"objectCreatorHasAccessPermission": true,
"objectCreatorHasGrantPermission": true,
"projectProtection": {
"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}",
"protected": true
},
"usingAcl": true,
"usingPolicy": true
},
"status": "AVAILABLE",
"superAdmins": [
"RAM$odps****@aliyunid.com:RAM_USER\n"
],
"threeTierModel": true,
"type": "managed"
},
"errorCode": "OBJECT_NOT_EXIST",
"errorMsg": "This object does not exist.",
"httpCode": 200,
"requestId": "0b87b7b316643495896551555e855b"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。