GetProject - MaxCompute - Alibaba Cloud Documentation Center

Queries the information about a MaxCompute project.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The name of the MaxCompute project.	odps_project
verbose	boolean	No	Specifies whether to use additional information.	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	0b87b7b316643495896551555e855b
httpCode	integer	The HTTP status code. 1xx: informational response. The request is received and is being processed. 2xx: success. The request is successfully received, understood, and accepted by the server. 3xx: redirection. The request is redirected, and further actions are required to complete the request. 4xx: client error. The request contains invalid request parameters and syntaxes, or specific request conditions cannot be met. 5xx: server error. The server cannot meet requirements due to other reasons.	200
errorCode	string	The error code.	040002
errorMsg	string	The error message.	error message.
data	object	The data returned.
name	string	The project name.	odps_project
owner	string	The account information of the project owner.	1565950907343451
type	string	The project type. Valid values: managed: internal project external: external project	managed
comment	string	The project description.	maxcompute project
defaultQuota	string	The default computing quota that is used to allocate computing resources. If you do not specify a computing quota for your project, the jobs that are initiated by your project consume the computing resources in the default quota. For more information about how to use computing resources, see Use quota groups for computing resources.	quota_a
status	string	The project status. Valid values: AVAILABLE READONLY FROZEN DELETING	AVAILABLE
productType	string	The billing method of the default computing quota.	PayAsYouGo
threeTierModel	boolean	Indicates whether data storage by schema is supported. MaxCompute supports the schema feature. This feature allows you to classify objects such as tables, resources, and user-defined functions (UDFs) in a project by schema. You can create multiple schemas in a project. For more information, see Schema-related operations.	true
costStorage	string	The total storage usage. The storage space that is occupied by your project, which is the logical storage space after your project data is collected and compressed.	16489027
regionId	string	The region ID.	cn-beijing
createdTime	long	The creation time.	1704380838000
properties	object	The basic properties of the project.
timezone	string	The time zone that is used by your project. The time zone is the same as the time zone specified by `odps.sql.timezone`.	Asia/Shanghai
retentionDays	long	The retention period for backup data. Unit: days. During the retention period, you can restore data of the version in use to the backup data of any version. Valid values: [0,30]. Default value: 1. The value 0 indicates that the backup feature is disabled.	1
allowFullScan	boolean	Indicates whether a full table scan is allowed in the project. A full table scan occupies a large number of resources, which reduces data processing efficiency. By default, the full table scan feature is disabled.	false
typeSystem	string	The data type edition. Valid values: 1: MaxCompute V1.0 data type edition 2: MaxCompute V2.0 data type edition hive: Hive-compatible data type edition For more information about the differences among the three data type editions, see Data type editions.	2.0
enableDecimal2	boolean	Indicates whether the DECIMAL type of the MaxCompute V2.0 data type edition is enabled.	true
sqlMeteringMax	string	The maximum consumption threshold of a single SQL statement. Formula: Amount of scanned data (GB) × Complexity.	1500
tableLifecycle	object	The table lifecycle properties.
type	string	The lifecycle type. Valid values: mandatory: The lifecycle clause is required in a table creation statement. optional: The lifecycle clause is optional in a table creation statement. If you do not configure a lifecycle for a table, the table does not expire. inherit: If you do not configure a lifecycle for a table when you create the table, the value of the odps.table.lifecycle.value parameter is used as the table lifecycle by default.	optional
value	string	The table lifecycle. Unit: days. Valid values: 1 to 37231. Default value: 37231.	37231
encryption	object	The storage encryption properties.
enable	boolean	Indicates whether the data encryption feature needs to be enabled for the project. For more information about data encryption, see Storage encryption.	true
algorithm	string	The data encryption algorithm that is supported by the key. Valid values: AES256, AESCTR, and RC4.	SHA1
key	string	The type of key that is used for data encryption. You can select MaxCompute Default Key or Bring Your Own Key (BYOK) as the key type. If you select MaxCompute Default Key, the default key that is created by MaxCompute is used.	dafault
tunnelQuota	string	The Tunnel resource group that is bound to the project. Default resource group: The Tunnel shared resource group is used. You cannot use the subscription-based Tunnel resource group for the project. The default resource group is automatically used by the Tunnel service of your project, regardless of the parameter setting. Subscription-based Tunnel resource group: You can use the subscription-based Tunnel resource group for the project.	Quota
elderTunnelQuota	string	The Tunnel parent resource group that is bound to the project. You do not need to pay attention to this group.	No value
enableTunnelQuotaRoute	boolean	Indicates whether the routing of the Tunnel resource group is enabled. true: The data transfer tasks that are submitted by the project by default use the Tunnel resource group that is bound to the project. false: The data transfer tasks that are submitted by the project by default use the Tunnel shared resource group.	true
storageTierInfo	object	The storage tier information.
storageTierSize	object	The storage tier information.
standardSize	long	The storage usage at the standard storage tier.	27649172
longTermSize	long	The storage usage at the long-term storage tier.	21764917
lowFrequencySize	long	The storage usage at the Infrequent Access (IA) layer.	767693
projectTotalSize	long	The total storage usage.	56066037
projectBackupSize	long	The backup storage usage.	86672917
fdcQuota	string	The quota for external table caching.	fdc_quota
enableFdcCacheForce	boolean	Indicates whether external table caching is forcefully enabled.	true
enableTieredStorage	boolean	Indicates whether tiered storage is enabled.	true
tableLifecycleConfig	object	The properties of tiered storage lifecycle rules. After you configure the properties, the system triggers automatic switching of storage tiers based on the rules.
TierToLongterm	object	The information about the long-term storage tier.
DaysAfterLastModificationGreaterThan	long	The system triggers an automatic storage tier change N days after the last modification time of data. N is specified by this parameter and corresponds to `LastModifiedTime` that is configured for the table or partition.	180
DaysAfterLastAccessGreaterThan	long	The system triggers an automatic storage tier change N days after the last access time of data. N is specified by this parameter and corresponds to `LastAccessTime` that is configured for the table or partition. Note If LastAccessTime of a table or partition is left empty, the following rules are applied: For tables or partitions that you created before October 1, 2023, 2023.10.01 00:00:00 in UTC+0 is considered as the last access time. For tables or partitions that you created on or after October 1, 2023, if no data is accessed, the table or partition creation time is considered as the last access time.	180
DaysAfterLastTierModificationGreaterThan	long	The period after the previous storage tier change time.	1
TierToLowFrequency	object	The information about the IA storage tier.
DaysAfterLastModificationGreaterThan	long	The system triggers an automatic storage tier change N days after the last modification time of data. N is specified by this parameter and corresponds to `LastModifiedTime` that is configured for the table or partition.	30
DaysAfterLastAccessGreaterThan	long	The system triggers an automatic storage tier change N days after the last access time of data. N is specified by this parameter and corresponds to `LastAccessTime` that is configured for the table or partition. Note If LastAccessTime of a table or partition is left empty, the following rules are applied: For tables or partitions that you created before October 1, 2023, 2023.10.01 00:00:00 in UTC+0 is considered as the last access time. For tables or partitions that you created on or after October 1, 2023, if no data is accessed, the table or partition creation time is considered as the last access time.	30
DaysAfterLastTierModificationGreaterThan	long	The period after the previous storage tier change time.	1
externalProjectProperties	object	The properties of the external project.
isExternalCatalogBound	string	Indicates whether the external project is an external project for data lakehouse solution 2.0.	true
superAdmins	array	The list of `Super_Administrator` role members of the project.
superAdmin	string	The account information of the `Super_Administrator` role members of the project.	ALIYUN$***@aliyun.com
securityProperties	object	The permission properties.
usingAcl	boolean	Indicates whether the ACL-based access control feature is enabled. By default, this feature is enabled.	true
usingPolicy	boolean	Indicates whether the policy-based access control feature is enabled. By default, this feature is enabled.	true
objectCreatorHasAccessPermission	boolean	Indicates whether to allow the object creator to have the access permissions on the object. The default value is true, which indicates that the object creator has the access permissions on the object.	true
objectCreatorHasGrantPermission	boolean	Indicates whether the object creator has the authorization permissions on the object. The default value is true, which indicates that the object creator has the authorization permissions on the object.	true
labelSecurity	boolean	Indicates whether the label-based access control feature is enabled. By default, this feature is disabled.	false
enableDownloadPrivilege	boolean	Indicates whether the download control feature is enabled. By default, this feature is disabled.	false
projectProtection	object	The properties of the data protection mechanism.
exceptionPolicy	string	If you enable the project data protection mechanism, you can configure exception or trusted projects. This allows specified users to transfer data of a specified object to a specified project. The project data protection mechanism does not take effect in all the situations that are specified in the exception policy.	{ "Version": "1", "Statement": [{ "Effect":"Allow", "Principal":"<Principal>", "Action":["odps:<Action1>[, <Action2>, ...]"], "Resource":"acs:odps:*:<Resource>", "Condition":{ "StringEquals": { "odps:TaskType":["<Tasktype>"] } } }] }
protected	boolean	Indicates whether the data protection mechanism is enabled for the project. This allows or denies data transfer across projects. By default, the data protection mechanism is disabled.	true
ipWhiteList	object	The information about the IP address whitelist.
ipList	string	The IP address whitelist for access over the Internet or the network for interconnecting with other Alibaba Cloud services. Note If you configure only the IP address whitelist for access over the Internet or the network for interconnecting with other Alibaba Cloud services, the access over the Internet or the network for interconnecting with other Alibaba Cloud services is subject to configurations, and access over a virtual private cloud (VPC) is not allowed.	10.88.111.3
vpcIpList	string	The IP address whitelist for access over a VPC. Note If you configure only the IP address whitelist for access over a VPC, the access over a VPC is subject to configurations, and the access over the Internet or the network for interconnecting with other Alibaba Cloud services is not allowed.	10.88.111.3
saleTag	object	The instance ID and billing method of the default computing quota.
resourceId	string	The instance ID of the default computing quota.	project_name
resourceType	string	The billing method of the default computing quota.	project

Examples

Sample success responses

JSONformat

{
  "requestId": "0b87b7b316643495896551555e855b",
  "httpCode": 200,
  "errorCode": "040002",
  "errorMsg": "error message.",
  "data": {
    "name": "odps_project",
    "owner": "1565950907343451",
    "type": "managed",
    "comment": "maxcompute project\n",
    "defaultQuota": "quota_a",
    "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": "SHA1",
        "key": "dafault"
      },
      "tunnelQuota": "Quota",
      "elderTunnelQuota": "No value\n",
      "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"
      }
    },
    "superAdmins": [
      "ALIYUN$***@aliyun.com"
    ],
    "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\":\"<Principal>\",\n        \"Action\":[\"odps:<Action1>[, <Action2>, ...]\"],\n        \"Resource\":\"acs:odps:*:<Resource>\",\n        \"Condition\":{\n            \"StringEquals\": {\n                \"odps:TaskType\":[\"<Tasktype>\"]\n            }\n        }\n    }]\n    }",
        "protected": true
      }
    },
    "ipWhiteList": {
      "ipList": "10.88.111.3",
      "vpcIpList": "10.88.111.3"
    },
    "saleTag": {
      "resourceId": "project_name",
      "resourceType": "project"
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-20	The response structure of the API has changed	View Change Details
2024-09-12	The response structure of the API has changed	View Change Details
2024-07-11	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-06-25	The response structure of the API has changed	View Change Details
2024-06-24	The response structure of the API has changed	View Change Details
2024-06-24	The response structure of the API has changed	View Change Details
2024-04-17	The response structure of the API has changed	View Change Details
2024-01-08	The response structure of the API has changed	View Change Details
2023-12-28	API Description Update. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-11-21	The response structure of the API has changed	View Change Details
2023-09-21	The response structure of the API has changed	View Change Details
2023-09-14	API Description Update. The response structure of the API has changed	View Change Details