UpdateProjectBasicMeta - MaxCompute - Alibaba Cloud Documentation Center

Modifies the basic information of a project.

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

update

*Project

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

None

Request syntax

PUT /api/v1/projects/{projectName}/meta HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The name of the project.	odps_project

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.	{ "status":"", // AVAILABLE 表示恢复项目，FROZEN 冻结项目 "comment": "", "propertis": {} } - 注： comment 如果不更新就给 null。如果給空字符串就会改成空具体properties 属性kv与 GetProject 中返回的properties 一致。按需修改提交，不要每次提交全部属性列表如果是重置，则相关value置为空字符串即可。
comment	string	No	The description of the project.	BI_Analysis
properties	object	No	The basic properties of the project.
allowFullScan	boolean	No	Specifies whether to allow full table scans in the project. A full table scan consumes a large amount of resources. To improve processing efficiency, this feature is disabled by default.	false
enableDecimal2	boolean	No	Specifies whether to enable the Decimal data type of MaxCompute V2.0 for the project.	true
enableTunnelQuotaRoute	boolean	No	Specifies whether to enable resource group-based routing for Data Transmission Service. true: Data transmission tasks submitted in the project use the attached Data Transmission Service resource group by default. false: Data transmission tasks submitted in the project use the shared Data Transmission Service resource group by default.	true
encryption	object	No	The storage encryption properties.
enable	boolean	No	Specifies whether to enable data encryption for the project. For more information about data encryption, see Storage encryption.	true
key	string	No	The type of key used for data encryption. This can be the default MaxCompute key or a Bring-Your-Own-Key (BYOK). The default MaxCompute key is created within MaxCompute.	default
algorithm	string	No	The encryption algorithm. The key supports algorithms such as AES256, AESCTR, and RC4.	AES256
retentionDays	integer	No	The number of days to retain backup data. During this period, you can restore the current version to any backup version. The value must be an integer from 0 to 30. The default value is 1. A value of 0 disables the backup feature.	1
sqlMeteringMax	string	No	The maximum consumption threshold for a single SQL job. Unit: Scanned data (GB) × Complexity.	1500
tableLifecycle	object	No	The lifecycle properties of the table.
type	string	No	The lifecycle type. Valid values: mandatory: The Lifecycle clause is required. You must set a lifecycle for the table. optional: The Lifecycle clause is optional when you create a table. If you do not set a lifecycle for the table, the table never expires. inherit: If you do not set a lifecycle for the table when you create it, the lifecycle of the table is the value of odps.table.lifecycle.value.	optional
value	string	No	The lifecycle of the table in days. The value must be an integer from 1 to 37231. The default value is 37231.	37231
timezone	string	No	The time zone of the project. This is the `odps.sql.timezone` property.	Asia/Shanghai
tunnelQuota	string	No	The Data Transmission Service resource group attached to the project. Default (shared Data Transmission Service resource group): The project is not allowed to use a subscription Data Transmission Service resource group. Regardless of the value of the default Data Transmission Service resource group, data transmission tasks submitted in the project automatically use the Default resource group. Subscription Data Transmission Service resource group: The project is allowed to use a subscription Data Transmission Service resource group.	Default
typeSystem	string	No	The data type edition. Valid values: 1: Edition 1.0 2: Edition 2.0 hive: Hive-compatible edition For more information about the differences between the data type editions, see Data type editions.	2.0
enableDr	boolean	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	0b87b7e216652820458545253e8b0a
httpCode	integer	The HTTP status code. 1xx: Informational response - The request has been received and is being processed. 2xx: Success - The request was successfully received, understood, and accepted. 3xx: Redirection - The request was redirected. Further action is needed to complete the request. 4xx: Client error - The request contains incorrect request parameters or syntax, or cannot be fulfilled. 5xx: Server error - The server failed to fulfill the request for other reasons.	200
errorCode	string	The error code.	OBJECT_NOT_EXIST
errorMsg	string	The error message.	This object does not exist.
data	string	The result of the request.	success

Examples

Success response

JSON format

{
  "requestId": "0b87b7e216652820458545253e8b0a",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.\n",
  "data": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.