Queries the information about a MaxCompute project.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
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
Examples
Sample success responses
JSON
format
{
"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-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 |