UpdateProject-阿里云帮助中心

Updates the information of an existing project.

Operation description

When updating project information, ensure that the project has been successfully created. For more information about creating a project, refer to the request parameter descriptions.
When updating project information, you only need to specify the fields that you want to update. Unspecified fields remain unchanged.
Project updates do not take effect immediately. It may take up to 5 minutes for the updates to take effect.

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

imm:UpdateProject

update

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. For more information about how to obtain the project name, see Create a project.	test-project
ServiceRole	string	No	The service role that is authorized for Intelligent Media Management (IMM) to access other cloud resources such as Object Storage Service (OSS). To use a custom service role, you can create a regular service role in the Resource Access Management (RAM) console and grant permissions to the role. For more information, see Create a regular service role and Grant permissions to a RAM role.	AliyunIMMDefaultRole
Description	string	No	The description of the project. The description must be 1 to 256 characters in length.	immtest
TemplateId	string	No	The ID of the workflow template. For more information, see Workflow templates and operators.	Official:ImageManagement
ProjectMaxDatasetCount	integer	No	The maximum number of datasets in the project. Valid values: 1 to 1000000000.	1000000000
DatasetMaxBindCount	integer	No	The maximum number of bindings per dataset. Valid values: 1 to 10.	10
DatasetMaxFileCount	integer	No	The maximum number of files per dataset. Valid values: 1 to 100000000.	100000000
DatasetMaxEntityCount	integer	No	The maximum number of metadata entities per dataset. Note Reserved parameter. No actual limit is imposed during use.	10000000000
DatasetMaxRelationCount	integer	No	The maximum number of metadata relations per dataset. Note Reserved parameter. No actual limit is imposed during use.	100000000000
DatasetMaxTotalFileSize	integer	No	The maximum total size of files in each dataset. If the limit is exceeded, no more indexes can be added. Unit: bytes.	90000000000000000
Tag	array<object>	No	The list of tags.
	object	No	The tag information.
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response elements

Element	Type	Description	Example
	object	The response struct.
Project	Project	The project information. For more information, see Project.
RequestId	string	The request ID.	D33C3574-4093-448E-86E7-15BE2BD3****

Examples

Success response

JSON format

{
  "Project": {
    "ProjectName": "immtest",
    "ServiceRole": "AliyunIMMDefaultRole",
    "TemplateId": "DefaultId",
    "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
    "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
    "Description": "test project",
    "ProjectQueriesPerSecond": 100,
    "EngineConcurrency": 100,
    "ProjectMaxDatasetCount": 1000000000,
    "DatasetMaxBindCount": 10,
    "DatasetMaxFileCount": 100000000,
    "DatasetMaxEntityCount": 10000000000,
    "DatasetMaxRelationCount": 100000000000,
    "DatasetMaxTotalFileSize": 90000000000000000,
    "DatasetCount": 5,
    "FileCount": 10,
    "TotalFileSize": 100000,
    "Tags": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  },
  "RequestId": "D33C3574-4093-448E-86E7-15BE2BD3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.