Modifies the basic information about a project.
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:UpdateProjectBasicMeta | update | *Project acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName} |
| none |
Request syntax
PUT /api/v1/projects/{projectName}/meta HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| projectName | string | Yes | Project name. | odps_project |
| body | object | No | Request body parameters. | |
| comment | string | No | The project description. | BI_Analysis |
| properties | object | No | The basic properties of the project. | |
| allowFullScan | boolean | No | 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 |
| enableDecimal2 | boolean | No | Indicates whether the DECIMAL type of the MaxCompute V2.0 data type edition is enabled. | true |
| enableTunnelQuotaRoute | boolean | No | Indicates whether the routing of the Tunnel resource group is enabled.
| true |
| encryption | object | No | The storage encryption properties. | |
| enable | boolean | No | Indicates whether the data encryption feature needs to be enabled for the project. For more information about data encryption, see | true |
| key | string | No | 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. | default |
| algorithm | string | No | The data encryption algorithm that is supported by the key. Valid values: AES256, AESCTR, and RC4. | AES256 |
| retentionDays | long | No | 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 |
| sqlMeteringMax | string | No | The maximum consumption threshold of a single SQL statement. Formula: Amount of scanned data (GB) × Complexity. | 1500 |
| tableLifecycle | object | No | The table lifecycle properties. | |
| type | string | No | The lifecycle type. Valid values:
| optional |
| value | string | No | The table lifecycle. Unit: days. Valid values: 1 to 37231. Default value: 37231. | 37231 |
| timezone | string | No | The time zone that is used by your project. The time zone is the same as the time zone specified by | Asia/Shanghai |
| tunnelQuota | string | No | The Data Transmission Service resource group that is bound to the project.
| Default |
| typeSystem | string | No | The data type edition. Valid values:
| 2.0 |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "0b87b7e216652820458545253e8b0a",
"httpCode": 200,
"errorCode": "OBJECT_NOT_EXIST",
"errorMsg": "This object does not exist.\n",
"data": "success"
}Error codes
For a list of error codes, visit the Service error codes.