GetProject-阿里云帮助中心

Operation description

Querying project information supports obtaining real-time file statistics information, which is enabled through parameter settings. For details, see the request parameters section.

Important File statistics are supported only for datasets created before December 20, 2025.

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

get

*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
WithStatistics	boolean	No	Specifies whether to collect file statistics. Default value: false. true: File statistics are collected. The FileCount and TotalFileSize fields in the Project struct are accurate and valid. false: File statistics are not collected. The FileCount and TotalFileSize fields in the Project struct may be inaccurate or both be 0. Important File statistics are supported only for datasets created before December 20, 2025.	true

Response elements

Element	Type	Description	Example
	object	The response struct.
Project	Project	The project information.
RequestId	string	The request ID.	5A022F78-B9A8-4ACC-BB6B-B3597553

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": "5A022F78-B9A8-4ACC-BB6B-B3597553"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.