tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribePayType

Last updated: 2023-12-01 16:39:41

    1. API Description

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

    This API (DescribePayType) is used to query billing information of the current account, such as billing mode and billing cycle.

    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 Params. The value used for this API: DescribePayType.
    Version Yes String Common Params. The value used for this API: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    Area No String Specifies the service area.
    mainland: Queries billing methods available in the Chinese mainland.
    overseas: Queries billing methods available in the regions outside the Chinese mainland.
    Global: Queries billing methods available across the globe.
    If it is not specified, it defaults to mainland.
    Product No String Specifies the product to query, either cdn (default) or ecdn.
    Type No String Specifies resources.
    flux: Traffic package
    https: HTTPS requests
    It defaults to flux if not specified.

    3. Output Parameters

    Parameter Name Type Description
    PayType String Billing type
    flux: Bill by traffic
    bandwidth: Bill by bandwidth
    request: Bill by the number of requests
    flux_sep: Bill by dynamic and static traffic separately
    bandwidth_sep: Bill by dynamic and static bandwidth separately
    If you incur any usage when switching the billing mode, the new mode will take effect the next day. If no usage is incurred, the new mode takes effect immediately.
    BillingCycle String Billing cycle
    day: Daily
    month: Monthly
    hour: Hourly
    StatType String Statistic data
    monthMax: Billed monthly based on the monthly average daily peak traffic
    day95: Billed monthly based on the daily 95th percentile bandwidth
    month95: Billed monthly based on the monthly 95th percentile bandwidth
    sum: Billed daily/monthly based on the total traffic or requests
    max: Billed daily based on the peak bandwidth
    RegionType String Regionl billing
    all: Unified billing for all regions
    multiple: Region-specific billing
    CurrentPayType String Current billing mode
    flux: Bill by traffic
    bandwidth: Bill by bandwidth
    request: Bill by the number of requests
    flux_sep: Bill by dynamic and static traffic separately
    bandwidth_sep: Bill by dynamic and static bandwidth separately
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the billing mode

    This example shows you how to query the billing mode.

    Input Example

    https://cdn.tencentcloudapi.com/?Action=DescribePayType
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "1732a0dd-48d8-4ff1-8dcb-7f04ca139825",
        "PayType": "flux",
        "StatType": "sum",
        "BillingCycle": "day",
        "RegionType": "all",
        "CurrentPayType": "flux"
    }
}

    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
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
    InternalError.DataSystemError Error with the data query. Please submit a ticket for troubleshooting.
    InternalError.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    InvalidParameter.EcdnInterfaceError API internal error. Please try again or contact the customer service for assistance.
    ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
    UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
    UnauthorizedOperation.CdnUserNoWhitelist You are not in the beta whitelist and thus have no permission to use this function.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy