Queries the access relationships for specified domain names that pass through a VPC firewall.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Lang |
string |
No |
The language of the response message. Valid values:
|
zh |
| StartTime |
string |
Yes |
The start time. This is a Unix timestamp. Unit: seconds. |
1656664560 |
| EndTime |
string |
Yes |
The end time. This is a Unix timestamp. Unit: seconds. |
1656750960 |
| PageSize |
string |
No |
The number of entries to return on each page. |
10 |
| CurrentPage |
string |
No |
The current page number. |
1 |
| DomainList |
array |
No |
The list of domain names. |
|
|
string |
No |
The domain name. |
example.com |
|
| SrcIP |
string |
No |
The source IP address of the access request. |
47.92.x.x |
| SrcVpcId |
string |
No |
The ID of the source VPC. |
vpc-t4nlt09olhpazpoeg**** |
| DstIP |
string |
No |
The destination IP address. |
34.136.111.XXX |
| DstVpcId |
string |
No |
The ID of the destination VPC. |
vpc-bp10w5nb30r4jzfyc**** |
| Sort |
string |
No |
The field to sort by. This is an enumeration value. Default value: TotalBytes. Valid values: TotalBytes: Sorts by total traffic. SessionCount: Sorts by the number of sessions. |
TotalBytes |
| Order |
string |
No |
The sort order. This is an enumeration value. Valid values: asc, desc. |
desc |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| TotalCount |
integer |
The total number of entries. |
132 |
| RequestId |
string |
The request ID. |
C5DDD596-1191-5F36-A504-8733045A**** |
| DataList |
array<object> |
The list of returned data. |
|
|
object |
The list of returned data. |
||
| 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 source region. |
cn-hangzhou |
| DstRegionId |
string |
The destination region. |
cn-beijing |
| TotalBytes |
integer |
The total traffic. Unit: bytes. |
16287823 |
| SessionCount |
integer |
The total number of sessions. |
27 |
| Business |
string |
The website service. |
|
| GroupName |
string |
The organization information. |
|
| IpsHitCnt |
integer |
The number of intrusion prevention system (IPS) hits. |
10 |
| FirstTime |
integer |
The time of the first occurrence. |
1767147003 |
| LastTime |
integer |
The time of the last occurrence. |
1767147003 |
| RequestBytes |
integer |
The request traffic. Unit: bytes. |
10000 |
| ResponseBytes |
integer |
The response traffic. Unit: bytes. |
10000 |
| DstVpcList |
array<object> |
The list of destination VPCs. |
|
|
object |
The list of destination VPCs. |
||
| 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.