Queries the log shipping tasks of a specified Logstore.

Request syntax

aliyunlog log list_shipper --project=<value> --logstore=<value> [--offset=<value>] [--size=<value>] [--access-id=<value>] [--access-key=<value>] [--sts-token=<value>] [--region-endpoint=<value>] [--client-name=<value>] [--jmes-filter=<value>] [--format-output=<value>] [--decode-output=<value>]

Request parameters

The following table describes the required and specific parameters of the list_shipper command.
Parameter Type Required Example Description
--project String Yes aliyun-test-project The name of the project.
--logstore String Yes logstore-a The name of the Logstore.
--offset Integer No 0 The start position of entries to return. Default value: 0.
--size Integer No 3 The maximum number of entries to return on each page. Maximum value: 500.
For information about the global parameters of the Log Service command-line interface (CLI), see Global variables.


  • Sample requests
    Query the shipping tasks of a specified Logstore. Run the following command:
    aliyunlog log list_shipper --project="aliyun-test-project" --logstore="logstore-a" --offset=0 --size=3
  • Sample responses
      "count": 1,
      "shipper": [
      "total": 1