DescribeIpStatus

Last updated: 2020-11-24 16:46:05

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

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://cdn.tencentcloudapi.com/?Action=DescribeIpStatus
&Domain=www.test.com
&<Common request parameter>

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.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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help