All Products
Search
Document Center

Simple Log Service:RetryShipperTask

Last Updated:Oct 26, 2023

Retries failed log shipping tasks.

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.

  • 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.
  • You can retry up to 10 failed log shipping tasks at a time.

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

PUT /logstores/{logstore}/shipper/{shipper}/tasks 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.

shipper String Path Yes test-shipper

The name of the log shipping task.

Array of String Body Yes "task-id-1", "task-id-2", "task-id-3"

The body of the request.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Type String application/json

The type of the response body.

Content-Length String 0

The length of the response body.

Connection String close

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.
Date String Sun, 27 May 2018 08:25:04 GMT

The time when the response was returned.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The request ID.

Examples

Sample requests

PUT /logstores/ali-test-logstore/shipper/test-shipper/tasks HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

[ "task-id-1", "task-id-2", "task-id-3" ]

Sample success responses

JSON format

HTTP/1.1 200 OK

Error codes

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

HTTP status code

Error code

Error message

Description

404

ProjectNotExist

The Project does not exist : projectName

The specified project does not exist.

404

LogStoreNotExist

Logstore logstoreName does not exist.

The specified Logstore does not exist.

404

ShipperNotExist

Shipper does not exist.

The specified log shipping task does not exist.

400

ParameterInvalid

Each time allows 10 task retries only.

The number of retried log shipping tasks exceeds 10.

500

InternalServerError

Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.