tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeIpStatus

最后更新时间：2023-12-01 16:39:42

    1. API Description

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

    This API is used to query the IP details of edge nodes (available soon) and intermediate nodes. Note that there is a certain delay in data availability.

    Note：

    If you have migrated your ECDN service to CDN, you can use the corresponding CDN API.

    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: DescribeIpStatus.
    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.
    Domain Yes String Acceleration domain name
    Layer No String Node type.
    edge: Edge server
    last: Intermediate server
    If this parameter is left empty, edge server information will be returned by default
    Area No String Specifies a region to query.
    mainland: Nodes in the Chinese mainland
    overseas: Nodes outside the Chinese mainland
    global: Global nodes
    Segment No Boolean Whether to return a value as an IP range
    ShowIpv6 No Boolean
    AbbreviationIpv6 No Boolean Whether to abbreviate the IPv6 address.

    3. Output Parameters

    Parameter Name Type Description
    Ips Array of IpStatus Node list
    TotalCount Integer Total number of nodes
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying domain name node information

    Input Example

    https://cdn.tencentcloudapi.com/?Action=DescribeIpStatus
&Domain=www.test.com
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "b6e9964d-26a3-49d0-adab-993e17d2f950",
        "Ips": [
            {
                "Ip": "1.1.1.1",
                "District": "Guangdong",
                "Isp": "China Telecom",
                "City": "Shenzhen",
                "Status": "online"
            }
        ]
    }
}

    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.CamSystemError Authentication system internal error.
    InternalError.CdnConfigError Failed to update the domain name configuration.
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.CdnQuerySystemError Internal error. Please try again or contact the customer service for assistance.
    InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
    InternalError.Error Service internal error. Please submit a ticket for troubleshooting.
    InternalError.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnConfigInvalidHost Invalid domain name. Please make sure the domain name is valid.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    ResourceNotFound.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
    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.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
    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.
    隐私条款服务条款缓存条款