tencent cloud

Feedback

DescribeCdnIp

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

    1. API Description

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

    This API is used to query CDN IP ownership.

    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: DescribeCdnIp.
    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.
    Ips.N Yes Array of String List of IPs to be queried

    3. Output Parameters

    Parameter Name Type Description
    Ips Array of CdnIp Node ownership details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying IP information

    Input Example

    POST / HTTP/1.1
    Host: cdn.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeCdnIp
    <Common request parameters>
    
    {
        "Ips": [
            "1.1.1.1"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "156bde25-56b5-4dae-9638-b7b08b08e4f6",
            "Ips": [
                {
                    "City": "shanghai",
                    "Ip": "1.1.1.1",
                    "Platform": "no",
                    "Location": "unknown",
                    "Area": "unknown",
                    "History": []
                }
            ]
        }
    }
    

    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.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    LimitExceeded.CdnCallingQueryIpTooOften Too frequent queries on IP ownership.
    LimitExceeded.CdnQueryIpBatchTooMany The number of IPs to be queried exceeds the limit.
    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.CdnUserAuthFail Fail to authenticate the CDN user.
    UnauthorizedOperation.CdnUserAuthWait The CDN user is pending authentication.
    UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.