tencent cloud



Last updated: 2024-04-07 11:57:49

    1. API Description

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

    This API is used to get the overview of private DNS records.

    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: DescribeDashboard.
    Version Yes String Common Params. The value used for this API: 2020-10-28.
    Region No String Common Params. This parameter is not required for this API.

    3. Output Parameters

    Parameter Name Type Description
    ZoneTotal Integer Total number of private domain DNS records
    ZoneVpcCount Integer Number of VPCs associated with private domain
    RequestTotalCount Integer Total number of historical requests
    FlowUsage Array of FlowUsage Traffic package usage
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Getting the overview of private DNS records

    Input Example

    POST / HTTP/1.1
    Host: privatedns.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDashboard
    <Common request parameters>

    Output Example

        "Response": {
            "RequestId": "3c979890-0dcf-917e-d7a696c04d429009",
            "ZoneTotal": 20,
            "ZoneVpcCount": 7,
            "RequestTotalCount": 10000,
            "FlowUsage": [
                    "FlowType": "zone",
                    "TotalQuantity": 20,
                    "AvailableQuantity": 20
                    "FlowType": "traffic",
                    "TotalQuantity": 2000000,
                    "AvailableQuantity": 2000000

    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
    AuthFailure Error with CAM signature/authentication.
    DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
    FailedOperation Operation failed.
    InternalError Internal error.
    InternalError.UndefiendError Undefined error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceInUse The resource is in use.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.UnauthorizedAccount Unverified user.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    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