全部產品
Search
文件中心

MaxCompute:GetProject - 擷取專案資訊

更新時間:Nov 06, 2025

查詢MaxCompute專案的基本資料。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

odps:GetProject

get

*Project

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

請求文法

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

請求返回參數。

requestId

string

請求 ID。

0b87b7b316643495896551555e855b

httpCode

integer

HTTP 狀態代碼。

  • 1xx:資訊響應 - 請求已接收,正在處理中。

  • 2xx:成功 - 請求動作已被服務端成功接收、理解並接受。

  • 3xx:重新導向 - 請求被重新導向,採取進一步行動以完成請求。

  • 4xx:用戶端錯誤 - 請求包含錯誤請求參、文法或特定請求條件無法滿足。

  • 5xx:服務端錯誤 - 伺服器由於其他原因無法滿足請求。

200

errorCode

string

錯誤碼。

OBJECT_NOT_EXIST

errorMsg

string

錯誤資訊。

This object does not exist.

data

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

productType

string

預設計算 Quota 的計費模式。

PayAsYouGo

threeTierModel

boolean

是否支援按 Schema 儲存。 MaxCompute 支援 Schema,處於 Project 下,Table、Resource、UDF 上的對象,對 Table、Resource、UDF 進行歸類。一個 Project 下可以有多個 Schema。詳情請參見 Schema 操作

true

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.0

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

elderTunnelQuota

string

專案繫結資料傳輸服務資源群組父組(無需關注)。

Default_p

enableTunnelQuotaRoute

boolean

是否開啟Data Transmission Service資源群組路由。

  • true:表示該專案預設提交的資料轉送任務會使用繫結資料傳輸服務資源群組。

  • false:表示該專案預設提交的資料轉送任務會使用Data Transmission Service共用資源組。

true

storageTierInfo

object

階層式存放區資訊。

storageTierSize

object

階層式存放區資訊。

standardSize

integer

標準儲存用量。

27649172

longTermSize

integer

長期儲存用量。

21764917

lowFrequencySize

integer

低頻儲存用量。

767693

projectTotalSize

integer

總儲存用量。

56066037

projectBackupSize

integer

備份儲存大小。

86672917

fdcQuota

string

外表緩衝 Quota。

fdc_quota

enableFdcCacheForce

boolean

是否強制開啟外表緩衝。

true

enableTieredStorage

boolean

是否開啟 階層式存放區

true

tableLifecycleConfig

object

階層式存放區生命週期規則屬性,設定後系統將基於該規則引發階層式存放區類型自動轉換。

TierToLongterm

object

長期儲存標識。

DaysAfterLastModificationGreaterThan

integer

距離資料最後修改時間超過多少天后自動化佈建,對應表或分區的LastModifiedTime

180

DaysAfterLastAccessGreaterThan

integer

距離資料最後訪問時間超過多少天后自動化佈建,對應表或分區的LastAccessTime

說明

若表或分區的 LastAccessTime 為空白,則:

  • 對於 2023 年 10 月 01 日前建立的表或分區,預設按照 UTC+0 時區的 2023.10.01 00:00:00 時間計算。

  • 對於 2023 年 10 月 01 日後建立的表或分區,若資料沒被訪問過,按照 CreateTime 時間計算。

180

DaysAfterLastTierModificationGreaterThan

integer

距離上次轉換儲存類型的時間。

1

TierToLowFrequency

object

低頻儲存標識。

DaysAfterLastModificationGreaterThan

integer

定義距離資料最後修改時間超過多少天后自動化佈建,對應表或分區的LastModifiedTime

30

DaysAfterLastAccessGreaterThan

integer

定義距離資料最後訪問時間超過多少天后自動化佈建,對應表或分區的LastAccessTime

說明

若表或分區的 LastAccessTime 為空白,則:

  • 對於 2023 年 10 月 01 日前建立的表或分區,預設按照 UTC+0 時區的 2023.10.01 00:00:00 時間計算。

  • 對於 2023 年 10 月 01 日後建立的表或分區,若資料沒被訪問過,按照 CreateTime 時間計算。

30

DaysAfterLastTierModificationGreaterThan

integer

距離上次轉換儲存類型的時間。

1

externalProjectProperties

object

外部項目屬性。

isExternalCatalogBound

string

是否為 湖倉一體 2.0外部項目。

true

tableFormat

string

warehouse

string

foreignServerName

string

foreignServerType

string

externalCatalogId

string

enableAutoMv

boolean

autoMvQuotaGb

integer

enableDr

boolean

superAdmins

array

專案的Super_Administrator角色成員列表。

string

專案的Super_Administrator角色成員帳號資訊。

RAM$odps****@aliyunid.com:RAM_USER

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

資料保護機制屬性。

exceptionPolicy

string

如選擇開啟專案空間資料保護,允許設定例外或受信任專案,指定使用者將指定對象的資料流出至指定專案,所有符合 Exception Policy 中描述的情形都可以打破資料保護機制。

{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }

protected

boolean

是否開啟專案的 資料保護機制,禁止或允許資料流出專案,預設為不開啟狀態。

true

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

樣本

正常返回樣本

JSON格式

{
  "requestId": "0b87b7b316643495896551555e855b",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.",
  "data": {
    "name": "odps_project",
    "owner": "ALIYUN$odps****@aliyunid.com",
    "type": "managed",
    "comment": "BI_Analysis",
    "defaultQuota": "os_PayAsYouGoQuota",
    "status": "AVAILABLE",
    "productType": "PayAsYouGo",
    "threeTierModel": true,
    "costStorage": "16489027",
    "regionId": "cn-beijing",
    "createdTime": 1704380838000,
    "properties": {
      "timezone": "Asia/Shanghai",
      "retentionDays": 1,
      "allowFullScan": false,
      "typeSystem": "2.0",
      "enableDecimal2": true,
      "sqlMeteringMax": "1500",
      "tableLifecycle": {
        "type": "optional",
        "value": "37231"
      },
      "encryption": {
        "enable": true,
        "algorithm": "AES256",
        "key": "dafault"
      },
      "tunnelQuota": "Default",
      "elderTunnelQuota": "Default_p",
      "enableTunnelQuotaRoute": true,
      "storageTierInfo": {
        "storageTierSize": {
          "standardSize": 27649172,
          "longTermSize": 21764917,
          "lowFrequencySize": 767693
        },
        "projectTotalSize": 56066037,
        "projectBackupSize": 86672917
      },
      "fdcQuota": "fdc_quota",
      "enableFdcCacheForce": true,
      "enableTieredStorage": true,
      "tableLifecycleConfig": {
        "TierToLongterm": {
          "DaysAfterLastModificationGreaterThan": 180,
          "DaysAfterLastAccessGreaterThan": 180,
          "DaysAfterLastTierModificationGreaterThan": 1
        },
        "TierToLowFrequency": {
          "DaysAfterLastModificationGreaterThan": 30,
          "DaysAfterLastAccessGreaterThan": 30,
          "DaysAfterLastTierModificationGreaterThan": 1
        }
      },
      "externalProjectProperties": {
        "isExternalCatalogBound": "true",
        "tableFormat": "",
        "warehouse": "",
        "foreignServerName": "",
        "foreignServerType": "",
        "externalCatalogId": ""
      },
      "enableAutoMv": true,
      "autoMvQuotaGb": 0,
      "enableDr": true
    },
    "superAdmins": [
      "RAM$odps****@aliyunid.com:RAM_USER\n"
    ],
    "securityProperties": {
      "usingAcl": true,
      "usingPolicy": true,
      "objectCreatorHasAccessPermission": true,
      "objectCreatorHasGrantPermission": true,
      "labelSecurity": false,
      "enableDownloadPrivilege": false,
      "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
      }
    },
    "ipWhiteList": {
      "ipList": "10.88.111.3",
      "vpcIpList": "10.88.111.3"
    },
    "saleTag": {
      "resourceId": "b7afb7d1-****-****-****-c393669c307b",
      "resourceType": "PayAsYouGo"
    }
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情