GetProject - MaxCompute - Alibaba Cloud Documentation Center

Queries the information about a MaxCompute project.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
odps:GetProject	Read	All Resources *	none	none

Request syntax

GET /api/v1/projects/{projectName}

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	PopResult
requestId	string	The ID of the request.	0b87b7b316643495896551555e855b
httpCode	integer	Indicates whether the request was successful. If this parameter was not empty and the value of this parameter was not 200, the request failed.	200
errorCode	string	The error code.	040002
errorMsg	string	The error message.	error message.
data	object	The returned data.
name	string	The name of the MaxCompute project.	odps_project
owner	string	The owner of the project.	1565950907343451
type	string	The type of the project. Valid values: -managed: The project is an internal project. -external: The project is an external project.	managed
comment	string	The comment of the project.	maxcompute project
defaultQuota	string	The default computing quota.	quota_a
status	string	The status of the project. Valid values: -AVAILABLE: The project was available. -READONLY: The project was read only. -FROZEN: The project was frozen. -DELETING: The project was being deleted.	AVAILABLE
productType	string	The billing method of the project.	PayAsYouGo
threeTierModel	boolean	Indicates whether the current project supports the three-layer model of MaxCompute.	true
costStorage	string	The storage usage.	16489027
regionId	string	RegionID	cn-beijing
createdTime	long	Create time	1704380838000
properties	object	The properties of the project.
timezone	string	The time zone of the project.	Asia/Shanghai
retentionDays	long	The number of days for which backup data can be retained.	1
allowFullScan	boolean	Indicates whether a full table scan on the project is enabled.	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.	2.0
enableDecimal2	boolean	Indicates whether the DECIMAL data type in MaxCompute V2.0 is enabled.	true
sqlMeteringMax	string	The upper limit for the resources that are consumed by an SQL statement.	1500
tableLifecycle	object	The lifecycle of the table in the project.
type	string	The type of the lifecycle. Valid values: -mandatory: The lifecycle clause is required. You must configure a lifecycle for a table. -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 by default.	optional
value	string	The retention period of a table. Unit: days.	37231
encryption	object	The encryption information.
enable	boolean	Indicates whether data encryption is enabled. Valid values: true and false.	true
algorithm	string	The name of the encryption algorithm.	SHA1
key	string	The key of the encryption algorithm.	dafault
tunnelQuota	string	The name of the tunnel quota.	Quota
elderTunnelQuota	string	This operation does not return a value for this parameter.	No value
enableTunnelQuotaRoute	boolean	Indicates whether tunnel quota routing is enabled.	true
storageTierInfo	object	The information about the tiered storage.
storageTierSize	object	The tiered storage.
standardSize	long	The standard storage.	27649172
longTermSize	long	The long-term storage.	21764917
lowFrequencySize	long	The IA storage.	767693
projectTotalSize	long	The total storage.	56066037
projectBackupSize	long	The backup storage.	86672917
superAdmins	array	The Super_Administrator role.
	string	The Super_Administrator role.	ALIYUN$***@aliyun.com
securityProperties	object	The permission properties.
usingAcl	boolean	Indicates whether ACL-based access control is enabled.	true
usingPolicy	boolean	Indicates whether policy-based access control is enabled.	true
objectCreatorHasAccessPermission	boolean	Indicates whether the object creator is allowed to perform operations on objects.	true
objectCreatorHasGrantPermission	boolean	Indicates whether the object creator is allowed to authorize other users to perform operations on objects.	true
labelSecurity	boolean	Indicates whether label-based access control is enabled.	false
enableDownloadPrivilege	boolean	Indicates whether Download control is enabled.	false
projectProtection	object	Indicates whether project data protection is enabled.
exceptionPolicy	string	The exception policy. If cross-project data access operations are required, the project owner must configure an exception policy in advance to allow the specified user to transfer data of a specified object from the current project to a specified project. After the exception policy is configured, data of the object can be transferred to the specified project even if the project data protection feature is enabled.	{ "Version": "1", "Statement": [{ "Effect":"Allow", "Principal":"<Principal>", "Action":["odps:<Action1>[, <Action2>, ...]"], "Resource":"acs:odps:*:<Resource>", "Condition":{ "StringEquals": { "odps:TaskType":["<Tasktype>"] } } }] }
protected	boolean	Indicates whether project data protection is enabled.	true
ipWhiteList	object	The IP address whitelist.
ipList	string	The list of IP addresses.	10.88.111.3
vpcIpList	string	The list of virtual private cloud (VPC) IP addresses.	10.88.111.3
saleTag	object	The tag.
resourceId	string	The ID of the resource.	project_name
resourceType	string	The type of the resource.	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
      }
    },
    "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

2024-01-08

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-12-28

API Description Update. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: verbose
Output Parameters	The response structure of the API has changed.

2023-11-21

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-09-21

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-09-14

API Description Update. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Output Parameters	The response structure of the API has changed.