tencent cloud



Last updated: 2023-12-04 16:31:58

    1. API Description

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

    This API is used to query the traffic package details of one or more instances.

    A maximum of 10 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 Params. The value used for this API: DescribeInstancesTrafficPackages.
    Version Yes String Common Params. The value used for this API: 2020-03-24.
    Region No String Common Params. This parameter is not required for this API.
    InstanceIds.N No Array of String Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the InstanceId returned by the DescribeInstances API.
    Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible instance traffic package details.
    InstanceTrafficPackageSet Array of InstanceTrafficPackage List of instance traffic package details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying instance traffic package details

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "TotalCount": 2,
            "InstanceTrafficPackageSet": [
                    "InstanceId": "lhins-7h98ep3z",
                    "TrafficPackageSet": [
                            "TrafficPackageId": "lhtfp-o1wtyyvx",
                            "TrafficUsed": 5905577,
                            "TrafficPackageTotal": 536870912000,
                            "TrafficPackageRemaining": 536865006423,
                            "TrafficOverflow": 0,
                            "StartTime": "2020-06-28T08:15:18Z",
                            "EndTime": "2020-07-28T08:15:17Z",
                            "Deadline": "2020-07-28T08:15:18Z",
                            "Status": "NETWORK_NORMAL"
                    "InstanceId": "lhins-abtdx7eb",
                    "TrafficPackageSet": [
                            "TrafficPackageId": "lhtfp-4noj8p75",
                            "TrafficUsed": 3435972,
                            "TrafficPackageTotal": 536870912000,
                            "TrafficPackageRemaining": 536867476028,
                            "TrafficOverflow": 0,
                            "StartTime": "2020-06-28T08:08:57Z",
                            "EndTime": "2020-07-28T08:08:56Z",
                            "Deadline": "2020-07-28T08:08:57Z",
                            "Status": "NETWORK_NORMAL"
            "RequestId": "7839b8ee-f5a4-4a67-b1ab-15fb35b1e2fe"

    5. Developer Resources


    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
    FailedOperation Operation failed.
    FailedOperation.DescribeInstancesTrafficPackagesFailed Failed to query traffic packages.
    InternalError.DescribeInstancesTrafficPackagesFailed An error occurred while querying the instance traffic package.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.Negative Invalid parametric value: it cannot be negative.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    UnauthorizedOperation.NoPermission No permission
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support