All Products
Search
Document Center

:ListProject

Last Updated:Apr 25, 2024

Queries the projects that meet specified conditions.

Operation description

Usage notes

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
log:ListProjectRead
  • Project
    acs:log:{#regionId}:{#accountId}:project/*
  • log:TLSVersion
none

Request parameters

ParameterTypeRequiredDescriptionExample
projectNamestringNo

The name of the project.

ali-test-project
offsetintegerNo

The line from which the query starts. Default value: 0.

0
sizeintegerNo

The number of entries per page. Default value: 100. This operation can return up to 500 projects.

10
resourceGroupIdstringNo

The ID of the resource group.

rg-aekzf******sxby

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring
nginx
Content-Lengthstring
0
Connectionstring
close
Access-Control-Allow-Originstring
*
Datestring
Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring
5B0A6B60BB6EE39764D458B5
object

The projects.

countlong

The number of returned projects on the current page.

2
totallong

The total number of projects that meet the query conditions.

11
projectsarray

The projects that meet the query conditions.

project

The project that meets the query conditions.

Examples

Sample success responses

JSONformat

{
  "count": 2,
  "total": 11,
  "projects": [
    {
      "createTime": "2021-07-07 14:08:09",
      "lastModifyTime": "2022-04-18 13:30:19",
      "description": "Description of my-project",
      "owner": "\"\"",
      "projectName": "ali-test-project",
      "region": "cn-hangzhou",
      "status": "Normal",
      "resourceGroupId": "rg-acf******sq"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.