All Products
Search
Document Center

Simple Log Service:SplitShard

Last Updated:Oct 26, 2023

Splits a shard that is in the readwrite state.

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.
  • Each shard has an MD5 hash range, and each range is a left-closed, right-open interval. The interval is in the [BeginKey,EndKey) format. A shard can be in the readwrite or readonly state. You can split and merge shards. For more information, see Shard.

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:SplitShardacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}

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

POST /logstores/{logstore}/shards/{shard}?action=split HTTP/1.1

Request parameters

ParameterTypePositionRequiredExampleDescription
projectStringHostYesali-test-project

The name of the project.

logstoreStringPathYeslogstorename

The name of the Logstore.

shardIntegerPathYes0

The ID of the shard.

keyStringQueryNoef000000000000000000000000000000

The position from which the shard is split.

shardCountIntegerQueryNo2

The number of shards into which the shard is split.

Response parameters

ParameterTypeExampleDescription
ServerStringnginx

The name of the server.

Content-TypeStringapplication/json

The type of the response body. Valid values: application/json and application/x-protobuf.

Content-LengthString20

The 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.
DateStringSun, 27 May 2018 08:25:04 GMT

The time when the response was returned.

x-log-requestidString5B0A6B60BB6EE39764D458B5

The request ID.

Array of shard

The shards that are returned. For example, if shardCount is set to 2, an array that consists of three shards is returned. The first shard is the original shard, and the last two shards are the new shards.

Examples

Sample requests

POST /logstores/logstorename/shards/{shard}?action=split?key=ef000000000000000000000000000000&shardCount=2 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

{
  "shardID" : 0,
  "status" : "readwrite",
  "inclusiveBeginKey" : "00000000000000000000000000000000",
  "exclusiveEndKey" : "8000000000000000000000000000000",
  "serverIp" : "10.0.xx.x",
  "createTime" : 1453949705
}

Error codes

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

HttpStatusCode

ErrorCode

ErrorMessage

Description

404

ProjectNotExist

Project does not exist.

The specified project does not exist.

404

LogStoreNotExist

Logstore does not exist.

The specified Logstore does not exist.

400

ParameterInvalid

invalid shard id.

The specified shard ID is invalid.

400

ParameterInvalid

invalid mid hash.

The key parameter is invalid.

400

LogStoreWithoutShard

logstore has no shard.

No shards exist in the specified Logstore.

500

InternalServerError

Specified Server Error Message.

An internal server error has occurred.

For more information, see Error codes.