Queries a list of MaxCompute projects.
Debugging
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 Resourcesis 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:ListProjects | list |
|
| none |
Request syntax
GET /api/v1/projects HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| tenantId | string | No | The tenant ID. | 549532154333697 |
| region | string | No | The ID of the region. | cn-beijing |
| quotaNickName | string | No | The name of the quota. | quotaA |
| quotaName | string | No | The name of the quota. The value of this parameter is the identifier of the quota in MaxCompute, which differs from the quotaNickname parameter. You can configure the quotaNickname parameter. The system automatically generates a value for the quotaName parameter. This parameter is only used to describe the tunnel quota. | "hsajkdgbkaubh" |
| prefix | string | No | Specifies the marker after which the returned list begins. | a |
| marker | string | No | The maximum number of entries to return on each page. | cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg== |
| maxItem | integer | No | The maximum number of entries returned per page. | 10 |
| saleTags | string | No | The identifier of an object in a MaxCompute quota. This identifier is the same as the identifier in the sales bill of Alibaba Cloud. This parameter is used for tags. | "aaaa-bbbb" |
| type | string | No | The project type. Valid values: external and managed. The value external indicates an external project, which is used in the data lakehouse solution. The value managed indicates an internal project. | "managed" |
| listSystemCatalog | boolean | No | Specifies whether to list a project named SystemCatalog. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "0b16399216671970335563173e2340",
"data": {
"projects": [
{
"name": "odps_project",
"owner": "1139815775606813",
"type": "managed",
"comment": "maxcompute projects\n",
"defaultQuota": "quotaA",
"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": "SHA1",
"key": "dafault"
},
"tunnelQuota": "quota_tunnel",
"enableTunnelQuotaRoute": 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": "\"aaaa-bbbb\"",
"resourceType": "\"project\""
},
"Tags": [
{
"TagValue": "acceptance test",
"TagKey": "Department"
}
],
"threeTierModel": true
}
],
"marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
"maxItem": 10,
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-12 | The response structure of the API has changed | View Change Details |
| 2024-07-31 | 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-11-14 | The request parameters of the API has changed. 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-08-23 | The request parameters of the API has changed | View Change Details |