All Products
Document Center

Simple Log Service:ListShards

Last Updated:Oct 26, 2023

Queries all shards in a Logstore.

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 pairs.

    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.

  • The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.

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.



log:ListShards acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}


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 /logstores/{logstore}/shards HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
project String Host Yes ali-test-project

The name of the project.

logstore String Path Yes ali-test-logstore

The name of the Logstore.

Response parameters

Parameter Type Example Description
Array of shard

The shards in the Logstore.


Sample requests

GET /logstores/ali-test-logstore/shards HTTP/1.1

Sample success responses

JSON format

HTTP/1.1 200 OK

[ {
  "shardID" : 0,
  "status" : "readwrite",
  "inclusiveBeginKey" : "00000000000000000000000000000000",
  "exclusiveEndKey" : "8000000000000000000000000000000",
  "serverIp" : "",
  "createTime" : 1453949705
} ]

Error codes

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







Project does not exist.

The specified project does not exist.



Logstore logstoreName does not exist.

The specified Logstore does not exist.



Shard ShardID does not exist.

The specified shard does not exist.



Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.