All Products
Search
Document Center

CDN:DescribeUserVipsByDomain

Last Updated:Jul 05, 2024

Queries virtual IP addresses (VIPs) of CDN points of presence (POPs) by domain name.

Operation description

Note You can call this operation up to 30 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name.

example.com
AvailablestringNo

Specifies whether to query the virtual IP addresses of only healthy CDN POPs. Valid values:

  • on: healthy CDN edge nodes.
  • off: all CDN edge nodes.
on

Response parameters

ParameterTypeDescriptionExample
object
DomainNamestring

The domain name.

example.com
RequestIdstring

The ID of the request.

820E7900-5CA9-4AEF-B0DD-20ED5F64BE55
Vipsarray

The list of VIPs.

string

The VIP.

122.72.xxx.xxx

Examples

Sample success responses

JSONformat

{
  "DomainName": "example.com",
  "RequestId": "820E7900-5CA9-4AEF-B0DD-20ED5F64BE55",
  "Vips": {
    "Vip": [
      "122.72.xxx.xxx"
    ]
  }
}

Error codes

HTTP status codeError codeError message
400MissingParameterThe specified value of parameter "DomainName" can not be empty.
400InvalidDomain.NotFoundThe domain provided is offline or not exist.
400IllegalOperationIllegal domain operate is not permitted.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history