DescribeShippers

Last updated: 2022-01-04 11:27:59

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to get the list of shipping rules.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeShippers.
Version Yes String Common parameter. The value used for this API: 2020-10-16.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Filters.N No Array of Filter
  • shipperName

    Filter by shipping rule name.
    Type: String

    Required: no


  • shipperId

    Filter by shipping rule ID.
    Type: String

    Required: no


  • topicId

    Filter by log topic.

    Type: String

    Required: no

    Each request can contain up to 10 Filters and 5 Filter.Values.
  • Offset No Integer Page offset. Default value: 0
    Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100

    3. Output Parameters

    Parameter Name Type Description
    Shippers Array of ShipperInfo Shipping rule list
    Note: this field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of results obtained in this query
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying shipping rules

    Input Example

    POST / HTTP/1.1
    Host: cls.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeShippers
    <Common request parameters>
    
    {
        "Filters": [
            {
                "Key": "shipperId",
                "Values": [
                    "xxxx-xxx-xxxx"
                ]
            }
        ],
        "Offset": 0,
        "Limit": 10
    }
    

    Output Example

    {
      "Response": {
        "Shippers": [
          {
            "ShipperId": "c9a96b57-9f35-4800-b5c7-6ce6173b7db5",
            "TopicId": "ab14dfa7-e9eb-4cd4-8300-2f35145f145e",
            "Bucket": "0052d6c8apbeijing100008449822-1254077820",
            "Prefix": "ab14dfa7-e9eb-4cd4-8300-2f35145f145e-1601543434",
            "ShipperName": "ap-beijing-carywu-1601543434",
            "Interval": 300,
            "MaxSize": 100,
            "Status": true,
            "FilterRules": [],
            "Partition": "/%Y/%m/%d/%H/",
            "Compress": {
              "Format": "gzip"
            },
            "Content": {
              "Format": "json"
            },
            "CreateTime": "2020-10-01 17:10:32"
          }
        ],
        "TotalCount": 1,
        "RequestId": "99bf3fb9-eb09-41e1-aac7-7e4e7ed08f5d"
      }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded The quota limit has been reached.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    OperationDenied.ACLFailed ACL verification failed.
    OperationDenied.AccountDestroy The account has been terminated.
    OperationDenied.AccountIsolate The account has overdue payments.
    OperationDenied.AccountNotExists The account does not exist.