All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodUserVipsByDomain

Last Updated:Oct 31, 2025

Queries the list of IP addresses associated with a domain name.

Operation description

This API operation is available only in the China (Shanghai) region.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DomainName

string

Yes

The accelerated domain name for Video on Demand (VOD). Only one domain name is supported.

example.com

Available

string

No

Specifies whether to query healthy virtual IP addresses (VIPs). Valid values:

  • on: Healthy VIPs.

  • off: All VIPs.

on

Response elements

Element

Type

Description

Example

object

The response schema.

DomainName

string

The VOD accelerated domain name.

example.com

RequestId

string

The request ID.

6730AC93-7B12-4B*****7F-49EE1FE8BC49

Vips

object

Vip

array

The list of VIP addresses.

string

A VIP address.

163.181.xxx.xxx

Examples

Success response

JSON format

{
  "DomainName": "example.com",
  "RequestId": "6730AC93-7B12-4B*****7F-49EE1FE8BC49",
  "Vips": {
    "Vip": [
      "163.181.xxx.xxx"
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter The specified value of parameter "DomainName" can not be empty.
400 InvalidDomain.NotFound The domain provided is offline or not exist.
400 IllegalOperation Illegal domain operate is not permitted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.