Use DescribeL2VipsByDomain to query L2 VIPs for a domain name - CDN - Alibaba Cloud - CDN

Operation description

This operation is available only to users whose daily peak bandwidth is 1 Gbps or higher. If you meet this requirement, submit a ticket to request access to this operation.

The throttling limit for this operation is 40 calls per second for each user.
This operation retrieves information only for acceleration domain names added in the CDN console, not those added in the DCDN console.

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:DescribeL2VipsByDomain

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The acceleration domain name. You can specify only one domain name per request.	example.com

Response elements

Element	Type	Description	Example
	object
DomainName	string	The domain name.	example.com
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Vips	object
Vip	array	The VIP list.
	string	The VIP address.	1.1.1.1/25

Examples

Success response

JSON format

{
  "DomainName": "example.com",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Vips": {
    "Vip": [
      "1.1.1.1/25"
    ]
  }
}

Error response

JSON format

{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8","HostId":"cdn.aliyuncs.com","Code":"InternalError","Message":"The request processing has failed due to some unknown error."}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalOperation	Illegal domain operate is not permitted.	Domain name does not support current operation
400	SingleRequest.OverLimit	A maximum of 1 DomainName is supported for each request.
403	SystemBusy	The system is busy, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.