DescribeVpcFirewallDomainRelationList-阿里云帮助中心

Queries connections to a specified domain name through VPC Firewall.

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

yundun-cloudfirewall:DescribeVpcFirewallDomainRelationList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh (default): Chinese en: English	zh
StartTime	string	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1656664560
EndTime	string	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1656750960
PageSize	string	No	The number of entries to return on each page.	10
CurrentPage	string	No	The number of the page to return.	1
DomainList	array	No	The list of domain names.
	string	No	The domain name.	example.com
SrcIP	string	No	The source IP address to query.	47.92.x.x
SrcVpcId	string	No	The ID of the source VPC.	vpc-t4nlt09olhpazpoeg****
DstIP	string	No	The destination IP address to query.	34.136.111.XXX
DstVpcId	string	No	The ID of the destination VPC.	vpc-bp10w5nb30r4jzfyc****
Sort	string	No	The field by which to sort the queried entries. Valid values: Default value: TotalBytes. Valid values: TotalBytes: Order by total traffic. SessionCount: Order by session count.	TotalBytes
Order	string	No	The order in which to sort the queried entries. Valid values:	desc

Response elements

Element	Type	Description	Example
	object	The data returned.
TotalCount	integer	The total number of entries.	132
RequestId	string	The request ID.	C5DDD596-1191-5F36-A504-8733045A****
DataList	array<object>	The list of data entries.
	object	A domain relationship.
Domain	string	The domain name.	www.example.com
SrcIP	string	The source IP address.	192.0.XX.XX
DstIP	string	The destination IP address.	192.0.XX.XX
SrcVpcId	string	The ID of the source VPC.	vpc-t4nlt09olhpazpoeg****
DstVpcId	string	The ID of the destination VPC.	vpc-bp10w5nb30r4jzfyc****
SrcVpcName	string	The name of the source VPC.	vpc-****
DstVpcName	string	The name of the destination VPC.	vpc-****
SrcRegionId	string	The ID of the source region.	cn-hangzhou
DstRegionId	string	The ID of the destination region.	cn-beijing
TotalBytes	integer	The total traffic, in bytes.	16287823
SessionCount	integer	The total number of sessions.	27
Business	string	The business category of the website.	Google
GroupName	string	The name of the organization.	Google
IpsHitCnt	integer	The IPS hit count.	10
FirstTime	integer	The Unix timestamp for the first access, in seconds.	1767147003
LastTime	integer	The Unix timestamp for the last access, in seconds.	1767147003
RequestBytes	integer	The request traffic, in bytes.	10000
ResponseBytes	integer	The response traffic, in bytes.	10000
DstVpcList	array<object>	A list of destination VPCs.
	object	A destination VPC.
VpcId	string	The ID of the destination VPC.	vpc-bp10w5nb30r4jzfyc****
VpcName	string	The name of the destination VPC.	vpc-****

Examples

Success response

JSON format

{
  "TotalCount": 132,
  "RequestId": "C5DDD596-1191-5F36-A504-8733045A****",
  "DataList": [
    {
      "Domain": "www.example.com",
      "SrcIP": "192.0.XX.XX",
      "DstIP": "192.0.XX.XX",
      "SrcVpcId": "vpc-t4nlt09olhpazpoeg****",
      "DstVpcId": "vpc-bp10w5nb30r4jzfyc****",
      "SrcVpcName": "vpc-****",
      "DstVpcName": "vpc-****",
      "SrcRegionId": "cn-hangzhou",
      "DstRegionId": "cn-beijing",
      "TotalBytes": 16287823,
      "SessionCount": 27,
      "Business": "Google",
      "GroupName": "Google",
      "IpsHitCnt": 10,
      "FirstTime": 1767147003,
      "LastTime": 1767147003,
      "RequestBytes": 10000,
      "ResponseBytes": 10000
    }
  ],
  "DstVpcList": [
    {
      "VpcId": "vpc-bp10w5nb30r4jzfyc****",
      "VpcName": "vpc-****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorTimeError	The time is invalid.	The time is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorIntervalError	The interval is invalid.	The interval is invalid.
400	ErrorIpFormat	The IP address is invalid.	The IP address is invalid.
400	ErrorSecuritySuggest	The security suggest is invalid.	The security suggest is invalid.
400	ErrorSortError	The sort is invalid.	The sort is invalid.
400	ErrorOrderFailed	The order is invalid.	The order is invalid.
400	ErrorPageNo	Either page number or page size is invalid.	Either page number or page size is invalid.
400	ErrorDomainName	The domain name is invalid.	The domain name is invalid.
400	ErrorDataTypeError	The data type is invalid.	The data type is invalid.
400	ErrorMarshalJSON	internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.