tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeIpStatus

Last updated: 2022-02-23 10:17:20

    1. API Description

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

    This API is used to query ECDN node IPs. This API is only available to beta users. Please submit a ticket to use it.

    If you need to add the node IPs to your origin allowlist, keep querying the updating the IPs regularly to ensure the success of origin forwarding.

    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.
    This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: DescribeIpStatus.
    Version Yes String Common parameter. The value used for this API: 2019-10-12.
    Region No String Common parameter. This parameter is not required for this API.
    Domain Yes String Acceleration domain name
    Area No String Target region of the query:
    mainland: nodes in Mainland China
    overseas: nodes outside Mainland China
    global: global nodes

    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 node information of domain name

    Input Example

    https://ecdn.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",
      "CreateTime": "2019-10-12 00:00:00"
    }
  ],
  "TotalCount": 0
}
}

    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.EcdnConfigError Internal configuration service error. Please try again later or contact the customer service for assistance.
    InternalError.EcdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.EcdnSystemError System error. Please submit a ticket for troubleshooting.
    InvalidParameter.EcdnParamError Parameter error. Please see the sample parameters in the documentation.
    ResourceNotFound.EcdnDomainNotExists This domain name does not exist under the account. Please check and try again.
    ResourceNotFound.EcdnHostNotExists This domain name does not exist under the account. Please check and try again.
    ResourceNotFound.EcdnUserNotExists The ECDN service has not been activated. Please activate it first before using this API.
    UnauthorizedOperation.EcdnCamUnauthorized No CAM policy is configured for the sub-account.
    UnauthorizedOperation.EcdnDomainUnauthorized The acceleration domain name is not authorized for the ECDN sub-account.
    UnauthorizedOperation.EcdnHostUnauthorized The acceleration domain name is not authorized for the ECDN sub-account.
    UnauthorizedOperation.EcdnUserNoWhitelist You are not on the beta allowlist and thus have no permission to use this feature.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy