All Products
Search

This Product

    Edge Security Acceleration:DescribeDcdnUserVipsByDomain

    Document Center

    Edge Security Acceleration:DescribeDcdnUserVipsByDomain

    Last Updated:Oct 17, 2024

    Queries virtual IP addresses of the POPs by domain name.

    Operation description

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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.

    Enumeration values: example.com

    		example.com
    AvailablestringNo

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

    • on: queries healthy VIPs.
    • off: queries all VIPs.
    		on

    Response parameters

    ParameterTypeDescriptionExample
    object
    DomainNamestring

    The domain name.

    		example.com
    RequestIdstring

    The request ID.

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

    The list of VIPs.

    Vipstring

    Details of the VIPs.

    		122.72.xxx.xxx

    Examples

    Sample success responses

    JSONformat

    {
  "DomainName": "example.com",
  "RequestId": "820E7900-5CA9-4AEF-B0DD-20ED5F64BE55\n",
  "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.