DescribeDcdnUserVipsByDomain - Edge Security Acceleration

Operation description

Note

Each user can call this operation up to 30 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

dcdn:DescribeDcdnUserVipsByDomain

none

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name. Only one domain name is supported. 枚举值： example.com : example.com	example.com
Available	string	No	Specifies whether to query only healthy virtual IP addresses (VIPs). Valid values: on: Queries only healthy VIPs. off: Queries all VIPs.	on

Response elements

Element	Type	Description	Example
	object
DomainName	string	The domain name.	example.com
RequestId	string	The request ID.	820E7900-5CA9-4AEF-B0DD-20ED5F64BE55
Vips	object
Vip	array	The list of VIPs.
	string	The virtual IP addresses (VIPs).	122.72.xxx.xxx

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
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.