All Products
Search
Document Center

Simple Log Service:ListProject

Last Updated:Oct 26, 2023

Queries the projects that meet specified conditions.

Usage notes

  • Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
  • An AccessKey pair is created and obtained. For more information, see AccessKey pair.

    The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Log Service.

Authentication resources

The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.

Action

Resource

log:ListProjectacs:log:{#regionId}:{#accountId}:project/*

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

GET / HTTP/1.1

Request parameters

ParameterTypePositionRequiredExampleDescription
projectNameStringQueryNoali-test-project

The name of the project.

offsetIntegerQueryNo0

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

sizeIntegerQueryNo10

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

resourceGroupIdStringPathNorg-aekzf******sxby

The ID of the resource group.

Response parameters

ParameterTypeExampleDescription
ServerStringnginx

The name of the server.

Content-LengthString0

The content length of the response body.

ConnectionStringclose

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
Access-Control-Allow-OriginString*

The origin from which cross-origin requests are allowed to access the resource. If an origin is specified, only the cross-origin requests that are sent from the specified origin are allowed. Example origin: https://example.com/. If an asterisk (*) is specified, the cross-origin requests that are sent from all origins are allowed.

DateStringSun, 27 May 2018 08:25:04 GMT

The time at which the response was returned.

x-log-requestidString5B0A6B60BB6EE39764D458B5

The request ID.

countLong2

The number of returned projects on the current page.

totalLong11

The total number of projects that meet the query conditions.

projectsArray of project

The projects that meet the query conditions.

Examples

Sample requests

GET /?projectName=ali-test-project&offset=0&size=10 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "count" : 2,
  "total" : 11,
  "projects" : [ {
    "projectName" : "regular-nginx",
    "status" : "Normal",
    "owner" : "",
    "description" : "",
    "region" : "cn-hangzhou",
    "createTime" : "1656666120",
    "lastModifyTime" : "1656666120"
  }, {
    "projectName" : "k8s-log-c0a43da7f21a7444bb0d710f6f6b2bb5c",
    "status" : "Normal",
    "owner" : "",
    "description" : "k8s log project, created by alibaba cloud log controller",
    "region" : "cn-hangzhou",
    "createTime" : "1656496084",
    "lastModifyTime" : "1656496084"
  } ]
}

Error codes

For a list of error codes, see Service error codes.

HTTP status code

Error code

Error message

Description

404

ParameterInvalid

offset : offset pair is invalid

The value of the offset parameter is invalid.

500

InternalServerError

Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.