ListProjects-阿里云帮助中心

Operation description

Supports paginated data retrieval. Paged query the first page, set MaxResults to limit the number of returned entries. The NextToken value in the response serves as the token for querying subsequent pages. Paged query subsequent pages, set the NextToken parameter to the NextToken value obtained from the previous response, and set MaxResults to limit the number of returned entries.

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

list

*Project

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

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The maximum number of projects to return. Valid values: 0 to 200. If this parameter is not set or is set to 0, the default value is 100.	100
NextToken	string	No	The query token. Set the value to the NextToken value returned from the previous API call. The list of projects is returned in lexicographical order starting from the NextToken value. Leave this parameter empty when you call this API operation for the first time.	MTIzNDU2Nzg6aW1tdGVzdDAx
Prefix	string	No	The prefix used to filter projects. The length is limited to 0 to 128 characters.	immtest
Tag	array<object>	No	The tag list.
	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.
NextToken	string	The token used to query subsequent pages when the expected total number of returned projects is greater than the specified MaxResults value. This parameter has a value only when not all projects are returned.	MTIzNDU2Nzg6aW1tdGVzdDAx
Projects	array	The array of projects, which contains the information about each project.
	Project	The project information.
RequestId	string	The request ID.	4A7A2D0E-D8B8-4DA0-8127-EB32C660

Examples

Success response

JSON format

{
  "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": "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": "4A7A2D0E-D8B8-4DA0-8127-EB32C660"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.