DescribeVpcFirewallAccessDetail - 获取VPC防火墙接入详情

更新时间:
复制 MD 格式

获取VPC防火墙接入详情。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeVpcFirewallAccessDetail

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Lang

string

语言类型。取值:

  • zh(默认):中文

  • en:英文

zh

StartTime

string

查询开始时间。使用秒级时间戳格式表示。

1655778046

EndTime

string

查询结束时间。使用秒级时间戳格式表示。

1729042555

VpcId

string

VPC 实例 ID。

vpc-2ze4xj5kmb5udb****

Port

string

端口号。AssetIP 和 Port 至少需要提供一个,两者都为空时 API 返回 400 错误。

80

Direction

string

流量的方向。取值:

  • in:表示进方向。

  • out:表示出方向。

说明

不设置该参数表示查询所有流量方向。

in

IPProtocol

string

协议类型。取值:

  • tcp:tcp 协议

  • udp:udp 协议

tcp

RiskLevel

string

风险评估等级。

3

PeerVpcId

string

对端 VPC 的实例 ID。

vpc-90rq0anm6t8vbwbo****

PeerAssetIP

string

对端源 IP。

10.125.1.XX

PeerAssetInstanceId

string

对端资产实例 ID。

i-123451

PeerAssetInstanceName

string

对端资产实例名。

ecs22

AssetIP

string

本端资产 ip。AssetIP 和 Port 至少需要提供一个,两者都为空时 API 返回 400 错误。

192.0.XX.XX

Sort

string

排序方式。取值如下:

  • InBytes

  • OutBytes

  • TotalBytes

  • InPackets

  • OutPackets

  • SessionCount

InBytes

Order

string

升降序。取值:

  • asc:升序。

  • desc(默认):降序。

desc

CurrentPage

string

分页查询时,设置当前页的页码。

1

PageSize

string

分页查询时,显示的当前页的大小。

10

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

总数。

9

RequestId

string

结果的请求 ID。

8EAC2347-E85A-5DFF-9F49-B8E1BAFB****

DataList

array<object>

返回数据列表。

object

返回数据。

SessionCount

integer

会话总数。

27

PeerAssetInstanceId

string

对端实例 ID。

i-123451

PeerAssetIP

string

对端源 IP。

10.125.1.XX

RegionNo

string

实例所在的地域 ID。

cn-shenzhen

OutBytes

integer

发送字节数, 单位 Bytes。

1123

InBytes

integer

接收字节数, 单位 Bytes。

17845821669

peerVpcName

string

对端 VPC 名称。

vpc-test

PeerVpcId

string

对端 VPC 的实例 ID。

vpc-123411

PeerAssetInstanceName

string

对端实例名。

test

示例

正常返回示例

JSON格式

{
  "TotalCount": 9,
  "RequestId": "8EAC2347-E85A-5DFF-9F49-B8E1BAFB****",
  "DataList": [
    {
      "SessionCount": 27,
      "PeerAssetInstanceId": "i-123451",
      "PeerAssetIP": "10.125.1.XX",
      "RegionNo": "cn-shenzhen",
      "OutBytes": 1123,
      "InBytes": 17845821669,
      "peerVpcName": "vpc-test",
      "PeerVpcId": "vpc-123411\n",
      "PeerAssetInstanceName": "test"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorParameters AssetIP and Port cannot be empty at the same time.
400 MissingParameter.AssetIpOrPort At least one of AssetIP or Port is required.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情