Query the status of IP addresses of CDN POPs by using DescribeIpStatus - CDN

Operation description

Note

Each account can call this operation up to 50 times per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeIpStatus

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Ips	string	Yes	The IP addresses that you want to query. Separate IP addresses with underscores (_), such as Ips=ip1_ip2.	ip1_ip2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F61CDR30-E83C-4FDA-BF73-9A94CDD44229
IpStatus	array<object>	The status of the IP addresses of the POPs.
	object
ip	string	The IP address of the POP.	10.10.10.10
status	string	The status. nonali: not an Alibaba Cloud CDN POP normal: an available Alibaba Cloud CDN POP abnormal: an unavailable Alibaba Cloud CDN POP	abnormal

Examples

Success response

JSON format

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "IpStatus": [
    {
      "ip": "10.10.10.10",
      "status": "abnormal"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidArgIps.Malformed	The specified ips is invalid.
400	InvalidArgIps.IpCanNotFound	The ips can not found.	The input parameter is not found in the system and is not the IP address of Alibaba Cloud CDN.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.