DescribeIpStatus

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-06-29 17:13:38

Download PDF

1. API Description

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

This API is used to query the status of the edge servers and intermediate nodes on the domain name acceleration platform. Note: edge servers are not generally available. This API can only be used by allowlisted accounts.

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 parameter. The value used for this API: DescribeIpStatus.
Version	Yes	String	Common parameter. The value used for this API: 2018-06-06.
Region	No	String	Common parameter. 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	Region to be queried. mainland: domestic nodes overseas: overseas nodes global: global nodes
Segment	No	Boolean	Whether to return a value as an IP range

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",
    "TotalCount": 1,
    "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

Tencent Cloud CLI 3.0

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.CdnConfigError	Failed to update the domain name configuration.
InternalError.CdnDbError	Internal data error. Please submit a ticket for troubleshooting.
InternalError.CdnSystemError	System error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnParamError	Parameter error. Please see the sample parameters in the documentation.
ResourceNotFound.CdnHostNotExists	This domain name does not exist under the account. Please check and try again.
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.

Recent Pages