DocsICP FilingConsole
官方文档
首页

DescribeVpcFirewallAssetList

更新时间：
复制 MD 格式
产品详情
我的收藏

Queries the asset list of a 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:DescribeVpcFirewallAssetList

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Lang

string

No

The language type of the request and response messages.

Valid values:

  • en :

    English.

  • zh :

    Chinese.

zh
Lang

string

No

请求和接收消息的语言类型。

Valid values:

  • en :

    英文

  • zh :

    中文

zh
StartTime

string

Yes

The start time. The value is a UNIX timestamp. Unit: seconds.

1534408189
EndTime

string

Yes

The end time. The value is a UNIX timestamp. Unit: seconds.

1756952150
VpcId

string

Yes

The instance ID of the VPC-connected instance.

vpc-wz9ulqcvly23w31zkh8sm****
PeerVpcId

string

No

The instance ID of the peer VPC.

vpc-90rq0anm6t8vbwbo****
Port

string

No

The port number.

5234
Direction

string

No

The traffic direction.

Valid values:

  • in :

    inbound.

  • out :

    outbound.

in
AppName

string

No

The application name.

test
IPProtocol

string

No

The protocol type.

Valid values:

  • tcp :

    tcp

  • udp :

    udp

tcp
RiskLevel

string

No

The risk level.

Valid values:

  • 0 :

    none.

  • 1 :

    low.

  • 2 :

    medium.

  • 3 :

    high.

3
EcsInstanceId

string

No

The instance ID of the ECS instance.

i-hp3ez3rs9bxwt034****
EcsInstanceName

string

No

The name of the asset instance.

test-ecs
AssetIP

string

No

The IP address of the asset.

192.0.XX.XX
Sort

string

No

The sort method.

Valid values:

  • InBytes :

    InBytes

  • SessionCount :

    SessionCount

  • OutBytes :

    OutBytes

SessionCount
Order

string

No

The sort order.

Valid values:

  • asc :

    ascending.

  • desc :

    descending.

desc
CurrentPage

string

No

The page number.

1
PageSize

string

No

The number of entries per page.

10
IsAITraffic

string

No

Specifies whether to collect statistics only on traffic that accesses AI services.

true

Response elements

Element

Type

Description

Example

object

TotalCount

integer

The total number of entries.

30
RequestId

string

The request ID.

924A6CCC-4EAD-5554-8AD0-45F5ED56****
DataList

array<object>

The data list.

object

The data list.

RiskLevel

integer

The risk level.

Valid values:

  • 0 :

    none.

  • 1 :

    low.

  • 2 :

    medium.

  • 3 :

    high.

3
SessionCount

integer

The total number of sessions.

27
AssetInstanceId

string

The ID of the asset instance.

i-hp3ez3rs9bxwt034****
OutBytes

integer

The outbound traffic. Unit: bytes.

0.0
RegionNo

string

The region.

cn-beijing
AssetIP

string

The IP address of the asset.

192.0.XX.XX
InBytes

integer

The inbound traffic. Unit: bytes.

0.0
AssetInstanceName

string

The name of the asset instance.

ecs-test
RiskReason

string

The risk reason.

test
PortList

array

The list of ports.

string

The list of ports.

[ 80, 8080, 80, 21 ]
TotalBytes

integer

The total traffic. Unit: bytes.

0
IpsHitCnt

integer

The number of IPS hits.

10

Examples

Success response

JSON format

{
  "TotalCount": 30,
  "RequestId": "924A6CCC-4EAD-5554-8AD0-45F5ED56****",
  "DataList": [
    {
      "RiskLevel": 3,
      "SessionCount": 27,
      "AssetInstanceId": " i-hp3ez3rs9bxwt034****",
      "OutBytes": 0,
      "RegionNo": "cn-beijing",
      "AssetIP": "192.0.XX.XX",
      "InBytes": 0,
      "AssetInstanceName": "ecs-test",
      "RiskReason": "test",
      "PortList": [
        "[\n  80,\n  8080,\n  80,\n  21\n]"
      ],
      "TotalBytes": 0,
      "IpsHitCnt": 10
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description
400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
400 ErrorMarshalJSON internal error. Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.