GetProject-阿里云帮助中心

Queries the basic information of a MaxCompute project.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

odps:GetProject

get

*Project

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

None

Request syntax

GET /api/v1/projects/{projectName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The project name.	odps_project

Request parameters

Parameter	Type	Required	Description	Example
verbose	boolean	No	Specifies whether to include additional information (securityProperties, superAdmins).	true
withStorageTierInfo	boolean	No	Specifies whether to include additional information (properties.storageTierInfo).	true
withQuotaProductType	boolean	No	Specifies whether to include additional information (productType).	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
data	object	The response data.
comment	string	The project description.	BI_Analysis
costStorage	string	The total storage size. Views the current storage size of the project. This storage size is consistent with the metering standard, which is the logical storage size after data is collected and compressed at the project level.	16489027
createdTime	integer	The creation time.	1704380838000
defaultQuota	string	The default computing quota. Used for compute resource allocation. If no computing quota is specified, jobs initiated by this project consume resources from the default quota. For more information about compute resource usage, see Compute resources - Quota usage .	os_PayAsYouGoQuota
ipWhiteList	object	The IP whitelist.
ipList	string	The IP whitelist for the Internet and cloud service interconnection network. Note If only the Internet and cloud service interconnection network IP whitelist is configured, access from the Internet and cloud service interconnection network is restricted by the configuration, and all VPC network access is prohibited.	10.88.111.3
vpcIpList	string	The IP whitelist for VPC networks. Note If only the VPC network IP whitelist is configured, VPC network access is restricted by the configuration, and all access from the Internet and cloud service interconnection network is prohibited.	10.88.111.3
name	string	The project name.	odps_project
owner	string	The account information of the project owner.	ALIYUN$odps****@aliyunid.com
productType	string	The billing method of the default computing quota.	PayAsYouGo
properties	object	The basic properties of the project.
allowFullScan	boolean	Specifies whether full table scans are allowed in the project. Full table scans consume a large amount of resources. To improve processing efficiency, this feature is disabled by default.	false
autoMvQuotaGb	integer
elderTunnelQuota	string	The parent group of the data transfer EPS resource group attached to the project. You can ignore this parameter.	Default_p
enableAutoMv	boolean
enableDataMasking	boolean
enableDecimal2	boolean	Specifies whether the Decimal data type of MaxCompute 2.0 is enabled for the project.	true
enableDr	boolean
enableFdcCacheForce	boolean	Specifies whether to forcibly enable external table caching.	true
enableTieredStorage	boolean	Specifies whether tiered storage is enabled.	true
enableTunnelQuotaRoute	boolean	Specifies whether data transfer EPS resource group routing is enabled. true: Data transfer tasks submitted by this project use the bound data transfer EPS resource group by default. false: Data transfer tasks submitted by this project use the shared data transfer EPS resource group by default.	true
encryption	object	The storage encryption properties.
algorithm	string	The data encryption algorithm. The supported encryption algorithms include AES256, AESCTR, and RC4.	AES256
enable	boolean	Specifies whether data encryption is enabled for the project. For more information about data encryption, see Storage encryption .	true
key	string	The type of key used for data encryption, including the default key (MaxCompute Default Key) and Bring Your Own Key (BYOK). The default key (MaxCompute Default Key) is a default key created internally by MaxCompute.	dafault
externalProjectProperties	object	The external project properties.
externalCatalogId	string
foreignServerName	string
foreignServerType	string
isExternalCatalogBound	string	Indicates whether this is a Data Lakehouse Solution 2.0 external project.	true
tableFormat	string
warehouse	string
fdcQuota	string	The external table cache quota.	fdc_quota
retentionDays	integer	The number of days that backup data is retained. During this period, you can restore the current version to any backed-up data version. Valid values: 0 to 30. Default value: 1. A value of 0 indicates that the backup feature is disabled.	1
sqlMeteringMax	string	The maximum threshold for a single SQL statement. Unit: scan volume (GB) × complexity.	1500
storageTierInfo	object	The tiered storage information.
projectBackupSize	integer	The backup storage size.	86672917
projectTotalSize	integer	The total storage usage.	56066037
storageTierSize	object	The tiered storage information.
longTermSize	integer	The long-term storage usage.	21764917
lowFrequencySize	integer	The low-frequency storage usage.	767693
standardSize	integer	The standard storage usage.	27649172
tableLifecycle	object	The lifecycle properties of the table.
type	string	The lifecycle type. Valid values: mandatory: The Lifecycle clause is required. You must set the lifecycle of the table. optional: The Lifecycle clause is optional when you create a table. If the lifecycle is not set, the table is permanently valid. inherit: If the lifecycle is not set when you create a table, the lifecycle of the table is the value of odps.table.lifecycle.value.	optional
value	string	The lifecycle of the table. Unit: days. Valid values: 1 to 37231. Default value: 37231.	37231
tableLifecycleConfig	object	The tiered storage lifecycle rules properties. After configuration, the system automatically triggers storage tier conversion based on these rules.
TierToLongterm	object	The long-term storage identifier.
DaysAfterLastAccessGreaterThan	integer	The number of days after the last access time of the data before the setting is automatically applied. This corresponds to the `LastAccessTime` of the table or partition. Note If the LastAccessTime of the table or partition is empty: For tables or partitions created before October 1, 2023, the calculation defaults to 2023.10.01 00:00:00 in the UTC+0 time zone. For tables or partitions created after October 1, 2023, if the data has not been accessed, the calculation is based on the CreateTime.	180
DaysAfterLastModificationGreaterThan	integer	The number of days after the last modification time of the data before the setting is automatically applied. This corresponds to the `LastModifiedTime` of the table or partition.	180
DaysAfterLastTierModificationGreaterThan	integer	The number of days since the last storage tier conversion.	1
TierToLowFrequency	object	The low-frequency storage identifier.
DaysAfterLastAccessGreaterThan	integer	The number of days after the last access time of the data before the setting is automatically applied. This corresponds to the `LastAccessTime` of the table or partition. Note If the LastAccessTime of the table or partition is empty: For tables or partitions created before October 1, 2023, the calculation defaults to 2023.10.01 00:00:00 in the UTC+0 time zone. For tables or partitions created after October 1, 2023, if the data has not been accessed, the calculation is based on the CreateTime.	30
DaysAfterLastModificationGreaterThan	integer	The number of days after the last modification time of the data before the setting is automatically applied. This corresponds to the `LastModifiedTime` of the table or partition.	30
DaysAfterLastTierModificationGreaterThan	integer	The number of days since the last storage tier conversion.	1
timezone	string	The project time zone, which is the `odps.sql.timezone` property.	Asia/Shanghai
tunnelQuota	string	The data transfer service resource group bound to the project. Default (shared data transfer EPS resource group): The project is not allowed to use a data transfer service (subscription) resource group. Regardless of the default data transfer EPS resource group setting, data transfer tasks submitted by this project automatically use the Default resource group. Data transfer service (subscription) resource group: The project is allowed to use a data transfer service (subscription) resource group.	Default
typeSystem	string	The data type version. Valid values: 1: version 1.0 2: version 2.0 hive: Hive-compatible type For differences among the three data type versions, see Data type editions .	2.0
regionId	string	The region ID.	cn-beijing
saleTag	object	The instance ID and billing type of the default computing quota.
resourceId	string	The instance ID of the default computing quota.	b7afb7d1-**--**-c393669c307b
resourceType	string	The billing type of the default computing quota.	PayAsYouGo
securityProperties	object	The security properties.
enableDownloadPrivilege	boolean	Specifies whether the Download permission control feature is enabled. This feature is disabled by default.	false
enableNamespacePrivilege	boolean	Specifies whether to enable IAM permissions.
labelSecurity	boolean	Specifies whether the Label-based access control feature is enabled. This feature is disabled by default.	false
objectCreatorHasAccessPermission	boolean	Specifies whether object creators are allowed to have access permissions on the objects they create. This is enabled by default.	true
objectCreatorHasGrantPermission	boolean	Specifies whether object creators are allowed to have grant permissions on the objects they create. This is enabled by default.	true
projectProtection	object	The data protection properties.
exceptionPolicy	string	If project data protection is enabled, you can set exceptions or trusted projects to allow specified users to export data of specified objects to specified projects. All scenarios described in the exception policy can override the data protection mechanism.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
protected	boolean	Indicates the enabling status of the data protection mechanism for the project, which prohibits or allows the data stream to flow out of the project. This is disabled by default.	true
usingAcl	boolean	Specifies whether the ACL-based access control feature is enabled. This feature is enabled by default.	true
usingPolicy	boolean	Specifies whether the Policy-based access control feature is enabled. This feature is enabled by default.	true
status	string	The project status. Valid values: AVAILABLE: Normal. READONLY: Read-only. FROZEN: Frozen. DELETING: Being deleted.	AVAILABLE
superAdmins	array	The list of members with the `Super_Administrator` role in the project.
	string	The account information of member accounts with the `Super_Administrator` role in the project.	RAM$odps****@aliyunid.com:RAM_USER
threeTierModel	boolean	Indicates whether schema-based storage is supported. MaxCompute supports schemas, which are objects under a project and above tables, resources, and UDFs, used to categorize tables, resources, and UDFs. A project can contain multiple schemas. For more information, see Schema operations .	true
type	string	The project type. Valid values: managed: Internal project. external: External project.	managed
errorCode	string	The error code.	OBJECT_NOT_EXIST
errorMsg	string	The error message.	This object does not exist.
httpCode	integer	The HTTP status code. 1xx: Informational response - The request has been received and is being processed. 2xx: Success - The request has been successfully received, understood, and accepted by the server. 3xx: Redirection - The request has been redirected. Further action is required to complete the request. 4xx: Client error - The request contains invalid parameters, syntax errors, or specific request conditions that cannot be met. 5xx: Server error - The server cannot fulfill the request due to other reasons.	200
requestId	string	The request ID.	0b87b7b316643495896551555e855b

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.