All Products
Search
Document Center

:GetShipperStatus

Last Updated:Apr 25, 2024

Queries the status of a log shipping job.

Operation description

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:GetShipperStatusRead
  • LogStore
    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/shipper/{#ShipperName}
  • log:TLSVersion
none

Request syntax

GET /logstores/{logstore}/shipper/{shipperName}/tasks

Request parameters

ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

ali-test-project
logstorestringYes

The name of the Logstore.

ali-test-logstore
shipperNamestringYes

The name of the log shipping job.

test-shipper
fromlongYes

The start time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1409529600
tolongYes

The end time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1627269085
statusstringNo

The status of the log shipping job. This parameter is empty by default, which indicates that log shipping jobs in all states are returned. Valid values: success, fail, and running.

success
offsetintegerNo

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

0
sizeintegerNo

The number of entries per page. Default value: 100. Maximum value: 500.

100

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring

The name of the server.

nginx
Content-Typestring

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

application/json
Content-Lengthstring

The content length of the response body.

0
Connectionstring

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.
close
Datestring

The time when the response was returned.

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

The request ID.

5B0A6B60BB6EE39764D458B5
object

The returned struct.

countlong

The number of log shipping jobs returned on the current page.

10
totallong

The total number of log shipping jobs.

20
statisticsobject

The statistics about log shipping jobs.

runninglong

The number of log shipping jobs that are in the running state.

0
successlong

The number of log shipping jobs that are in the success state.

20
faillong

The number of log shipping jobs that are in the fail state.

0
tasksobject

The details of log shipping jobs.

idstring

The ID of the log shipping job.

abcdefghijk
taskStatusstring

The status of the log shipping job. Valid values: running, success, and fail.

success
taskCodestring

The error code of the log shipping job.

UnAuthorized
taskMessagestring

The error message of the log shipping job.

Internal server error
taskCreateTimelong

The start time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1448925013
taskLastDataReceiveTimelong

The time when Simple Log Service receives the most recent log of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1448915013
taskFinishTimelong

The end time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1448926013
taskDataLinesinteger

The number of logs that are shipped in the log shipping job.

0

Examples

Sample success responses

JSONformat

{
  "count": 10,
  "total": 20,
  "statistics": {
    "running": 0,
    "success": 20,
    "fail": 0
  },
  "tasks": {
    "id": "abcdefghijk",
    "taskStatus": "success",
    "taskCode": "UnAuthorized",
    "taskMessage": "Internal server error",
    "taskCreateTime": 1448925013,
    "taskLastDataReceiveTime": 1448915013,
    "taskFinishTime": 1448926013,
    "taskDataLines": 0
  }
}

Error codes

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