Use ListProjects to query projects - MaxCompute - Alibaba Cloud - MaxCompute

Retrieves a list of MaxCompute projects.

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:ListProjects

list

Project

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

None

Request syntax

GET /api/v1/projects HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The tenant ID. To obtain the ID, log in to the MaxCompute console and select Tenant Management > Tenant Properties from the navigation pane on the left.	5495****3697
region	string	No	The region ID.	cn-beijing
quotaNickName	string	No	The quota nickname. To obtain the quota nickname, log in to the MaxCompute console and select Workspace > Quota Management from the navigation pane on the left.	os_PayAsYouGoQuota
quotaName	string	No	The quota name. The system automatically generates this name. To obtain the quota name, log in to the MaxCompute console and select Workspace > Quota Management from the navigation pane on the left.	aliyun_5495***3697
prefix	string	No	The prefix of the resource names to query. For example, if you specify `a` for this parameter, only resources whose names start with "a" are returned.	a
marker	string	No	The token that specifies the starting point of the query. The results are returned in alphabetical order, starting from the entry that immediately follows the marker.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	No	The maximum number of entries to return on each page. Default value: 10.	10
saleTags	string	No	The instance ID and billing method of the default compute quota.	{ "resourceId": "b7afb7d1-**--**-c393669c307b", "resourceType": "PayAsYouGo" }
type	string	No	The project type. Valid values: managed: a managed project. external: an external project.	managed
sortBy	string	No	The sort field. The only supported value is `createdTime`. Valid values: createdTime : Sorts by creation time.	createdTime
sortOrder	string	No	The sort order. This parameter takes effect only when `sortBy` is specified. Valid values are `ASC` and `DESC`. The values are case-insensitive. Valid values: ASC : Ascending order. DESC : Descending order.	DESC
listSystemCatalog	boolean	No	Specifies whether to list the built-in SYSTEM_CATALOG project. This project provides information such as project metadata and usage history. For more information, see Information Schema. Valid values: true : Includes the SYSTEM_CATALOG project in the results. false : Excludes the SYSTEM_CATALOG project from the results.	true

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The request ID.	0b16399216671970335563173e2340
data	object	The returned data.
projects	array<object>	The list of projects.
	array<object>	The project details.
name	string	The name of the project.	odps_project
owner	string	The owner of the project.	ALIYUN$odps****@aliyunid.com
type	string	The type of the project. Valid values: managed: An internal project. external: An external project.	managed
comment	string	The description of the project.	BI_Analysis
defaultQuota	string	The default compute quota. If you do not specify a quota for a job, the job consumes computing resources from this default quota. For more information about how to use computing resources, see Use of computing resources.	os_PayAsYouGoQuota
status	string	The status of the project. Valid values: AVAILABLE: The project is running as expected. READONLY: The project is read-only. FROZEN: The project is frozen. DELETING: The project is being deleted.	AVAILABLE
costStorage	string	The total storage usage of the project, which represents the compressed, logical data size used for metering.	16489027
regionId	string	The region ID.	cn-beijing
createdTime	integer	The time when the project was created, as a Unix timestamp in milliseconds.	1704380838000
properties	object	The basic properties of the project.
timezone	string	The time zone of the project. This parameter corresponds to the `odps.sql.timezone` property.	Asia/Shanghai
retentionDays	integer	The number of retention days for backup data. You can restore data to any backup version that is created within the retention period. Valid values: `0` to `30`. Default value: `1`. A value of `0` indicates that the backup feature is disabled.	1
allowFullScan	boolean	Specifies whether to allow a full table scan in the project. This feature is disabled by default because a full table scan can consume a large amount of computing resources.	false
typeSystem	string	The data type version. Valid values: 1: Version 1.0. 2: Version 2.0. hive: A Hive-compatible type. For more information about the differences between the data type versions, see Data type versions.	2
enableDecimal2	boolean	Specifies whether to enable the MaxCompute 2.0 Decimal data type in the project.	true
sqlMeteringMax	string	The maximum metered cost for a single SQL statement. The cost is calculated by using the formula: (scanned data in GB) × (complexity).	1500
tableLifecycle	object	The table lifecycle properties.
type	string	The type of the lifecycle. Valid values: mandatory: A lifecycle must be configured for each table. optional: The lifecycle is optional. If unspecified for a table, the table does not expire. inherit: If no lifecycle is specified for a table, the table inherits its lifecycle from the `odps.table.lifecycle.value` property.	optional
value	string	The lifecycle of the table, in days. Valid values: `1` to `37231`. Default value: `37231`.	37231
encryption	object	The storage encryption properties.
enable	boolean	Specifies whether to enable storage encryption for the project. For more information, see Storage encryption.	true
algorithm	string	The data encryption algorithm. Supported algorithms include AES256, AESCTR, and RC4.	AES256
key	string	The key for data encryption. You can use the default MaxCompute-managed key or a custom key with the Bring Your Own Key (BYOK) feature.	dafault
tunnelQuota	string	The Data Transmission Service resource group that is bound to the project. Default (shared Data Transmission Service resource group): The project cannot use subscription Data Transmission Service resource groups. Data Transmission Service jobs submitted from this project automatically use the Default resource group, regardless of the default setting for the Data Transmission Service resource group. Subscription Data Transmission Service resource group: The project can use a subscription Data Transmission Service resource group.	Default
enableTunnelQuotaRoute	boolean	Specifies whether to enable routing for the Data Transmission Service resource group. true: Data transmission jobs submitted by default from the project use the bound Data Transmission Service resource group. false: Data transmission jobs submitted by default from the project use the shared Data Transmission Service resource group.	true
externalProjectProperties	object	The properties of the external project.
isExternalCatalogBound	string	Specifies whether the project is an external project for Integrated Lakehouse.	true
securityProperties	object	The security-related properties.
usingAcl	boolean	Specifies whether to enable ACL-based access control. Default value: `true`.	true
usingPolicy	boolean	Specifies whether to enable policy-based access control. Default value: `true`.	true
objectCreatorHasAccessPermission	boolean	Specifies whether the creator of an object can access it. Default value: `true`.	true
objectCreatorHasGrantPermission	boolean	Specifies whether the creator of an object can grant other users permissions on it. Default value: `true`.	true
labelSecurity	boolean	Specifies whether to enable label-based access control. Default value: `false`.	false
enableDownloadPrivilege	boolean	Specifies whether to enable download control. Default value: `false`.	false
projectProtection	object	The project data protection properties.
protected	boolean	Specifies whether to enable project data protection to prevent data from being exported from the project. Default value: `false`.	true
exceptionPolicy	string	If project data protection is enabled, you can configure an exception policy. This policy allows specified users to export data from specified objects to trusted projects, bypassing the data protection mechanism.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
ipWhiteList	object	The IP whitelist.
ipList	string	The IP whitelist for access over the public network and from other Alibaba Cloud services. Note If you configure only this IP whitelist, access over the public network and from other Alibaba Cloud services is restricted based on the whitelist, and all access from VPCs is denied.	10.88.111.3
vpcIpList	string	The IP whitelist for access from VPCs. Note If you configure only the VPC IP whitelist, access from VPCs is restricted based on the whitelist, and all access over the public network and from other Alibaba Cloud services is denied.	10.88.111.3
saleTag	object	The instance ID and billing method of the default compute quota.
resourceId	string	The instance ID of the default compute quota.	b7afb7d1-**--**-c393669c307b
resourceType	string	The billing method of the default compute quota.	PayAsYouGo
threeTierModel	boolean	Specifies whether the project uses a three-tier model (project > schema > object). In this model, schemas are used within a project to organize objects such as tables, resources, and user-defined functions (UDFs). For more information, see Schema operations. Valid values: true : Supported false : Not supported	true
marker	string	A pagination marker used to retrieve the next page of results. This parameter is returned when the response is truncated.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	The maximum number of entries returned per page.	10
NextToken	string	The token for retrieving the next page of results. If this parameter is empty, all results have been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

Examples

Success response

JSON format

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com\n",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota\n",
        "status": "AVAILABLE",
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai\n",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231\n"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "enableTunnelQuotaRoute": true,
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "protected": true,
            "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}"
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b\n",
          "resourceType": "PayAsYouGo\n"
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.