Queries projects. You can call this operation to query the basic information, datasets, and file statistics of multiple projects at the same time.
Operation description
The ListProjects operation supports pagination. When you call this operation, you must specify the token that is obtained from the previous query as the value of NextToken. You must also specify MaxResults to limit the number of entries to return.
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 |
|---|---|---|---|---|
| imm:ListProjects | list | *Project acs:imm:{#regionId}:{#accountId}:project/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MaxResults | long | No | The maximum number of entries to return. Valid values: 0 to 200. Default value: 100. | 100 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. The operation returns the projects in lexicographical order starting from the location specified by NextToken. | MTIzNDU2Nzg6aW1tdGVzdDAx |
| Prefix | string | No | The prefix used by the projects that you want to query. The prefix must be up to 128 characters in length. | immtest |
| Tag | array<object> | No | The tags. | |
| object | No | The tag. | ||
| Key | string | No | The tag key. | TestKey |
| Value | string | No | The tag value. | TestValue |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "MTIzNDU2Nzg6aW1tdGVzdDAx",
"Projects": [
{
"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": "",
"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": "4A7A2D0E-D8B8-4DA0-8127-EB32C660"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-23 | The request parameters of the API has changed | View Change Details |
| 2021-06-10 | The Error code has changed | View Change Details |