调用DescribeAssetList查询云防火墙防护的资产的信息_云防火墙(Cloud Firewall)-阿里云帮助中心

查询云防火墙防护的资产的信息。

接口说明

本接口一般用于分页查询云防火墙防护的资产的信息。

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-cloudfirewall:DescribeAssetList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	接收消息的语言类型。取值： zh（默认）：中文。 en：英文。	zh
CurrentPage	string	是	分页查询时，设置当前页的页码。	1
PageSize	string	是	分页查询时，设置每页包含云防火墙防护资产的数量。	10
RegionNo	string	否	云防火墙所在的地域 ID。说明关于云防火墙支持地域的详细信息，请参见支持的地域。	cn-hangzhou
Status	string	否	云防火墙状态。取值： open：保护中。 opening：保护开启中。 closed：保护未开启。 closing：保护关闭中。说明不设置该参数表示查询所有防火墙状态。	open
SearchItem	string	否	资产的 IP 或者实例 ID。	192.0.XX.XX
Type	string	否	本参数已废弃。	eip
ResourceType	string	否	资产类型。取值： BastionHostEgressIP：堡垒机出口 IP。 BastionHostIngressIP：堡垒机入口 IP。 EcsEIP：ECS EIP。 EcsPublicIP：ECS 公网 IP。 EIP：弹性公网 IP。 EniEIP：弹性网卡 EIP。 NatEIP：NAT EIP。 SlbEIP：SLB EIP(CLB EIP)。 SlbPublicIP：SLB 公网 IP(CLB 公网 IP)。 NatPublicIP：NAT 公网 IP。 HAVIP：高可用虚拟 IP。	EIP
SgStatus	string	否	安全组策略状态。取值： pass：已下发。 block：未下发。 unsupport：不支持。说明不设置该参数表示查询所有安全组策略状态。	pass
IpVersion	string	否	云防火墙防护的资产的 IP 版本。取值： 4（默认）：IPv4。 6：IPv6。	4
MemberUid	long	否	云防火墙成员账号的 UID。	258039427902****
UserType	string	否	用户类型。取值： buy（默认）：付费用户。 free：免费用户。	buy
NewResourceTag	string	否	资产发现的时间。取值： discovered in 1 hour：资产是 1 小时内新增的。 discovered in 1 day：资产是 1 天内新增的。 discovered in 7 days：资产是 7 天内新增的。	discovered in 1 hour
OutStatistic	string	否	是否查询外联流量信息。	true
SensitiveStatus	string	否	数据泄漏检测开启状态。	open

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	云防火墙防护的资产总数量。	12
RequestId	string	结果的请求 ID。	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
Assets	array<object>	云防火墙防护的资产信息。
Resource	object
RiskLevel	string	资产的风险级别。取值： low：低风险。 middle：中风险。 hight：高风险。说明仅当 UserType 的值为 free 时，才会返回该参数。	low
BindInstanceName	string	绑定资产实例名称。	instance01
Type	string	该参数已废弃。	eip
SgStatusTime	long	最近一次安全组状态检测时间，使用时间戳格式。单位：秒。	1615082937
ResourceInstanceId	string	资产实例 ID。	i-8vbdrjrxzt78****
MemberUid	long	云防火墙成员账号的 UID。	258039427902****
IntranetAddress	string	服务器内网 IP。	192.168.XX.XX
SyncStatus	string	资产引流支持状态。取值： enable：支持引流。 disable：不支持引流。	enable
AliUid	long	阿里云账号的 UID。说明云防火墙成员账号的主账号。	158039427902****
ProtectStatus	string	防火墙状态。取值： open：保护中。 opening：保护开启中。 closed：未受保护。 closing：保护关闭中。	open
InternetAddress	string	服务器公网 IP。	192.0.XX.XX
BindInstanceId	string	绑定资产实例 ID。	i-8vbdrjrxzt78****
RegionID	string	资产所在的地域 ID。	cn-hangzhou
RegionStatus	string	资产所在地域是否支持开启云防火墙防护状态。取值： enable：支持。 disable：不支持。	enable
ResourceType	string	资产类型。取值： BastionHostEgressIP：堡垒机出口 IP。 BastionHostIngressIP：堡垒机入口 IP。 EcsEIP：ECS EIP。 EcsPublicIP：ECS 公网 IP。 EIP：弹性公网 IP。 EniEIP：弹性网卡 EIP。 NatEIP：NAT EIP。 SlbEIP：SLB EIP。 SlbPublicIP：SLB 公网 IP。 NatPublicIP：NAT 公网 IP。 HAVIP：高可用虚拟 IP。	EIP
IpVersion	integer	云防火墙防护的资产的 IP 地址版本。取值： 4：表示 IPv4 地址。 6：表示 IPv6 地址。	4
SgStatus	string	安全组策略。取值： pass：已下发。 block：未下发。 unsupport：不支持。	block
Note	string	资产的备注信息。取值： REGION_NOT_SUPPORT：地域不支持。 NETWORK_NOT_SUPPORT：网络不支持。	REGION_NOT_SUPPORT
Name	string	云防火墙防护的资产的实例名称。	instance01
CreateTimeStamp	string	云防火墙发现资产的时间。	2023-02-28 10:29:58
NewResourceTag	string	资产发现的时间。取值： discovered in 1 hour：资产是 1 小时内新增的。 discovered in 1 day：资产是 1 天内新增的。 discovered in 7 days：资产是 7 天内新增的。	discovered in 1 hour
SensitiveDataStatus	string	数据泄漏检测开启状态。	open
Last7DayOutTrafficBytes	long	近 7 日外联流量。	0

示例

正常返回示例

JSON格式

{
  "TotalCount": 12,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Assets": [
    {
      "RiskLevel": "low",
      "BindInstanceName": "instance01",
      "Type": "eip",
      "SgStatusTime": 1615082937,
      "ResourceInstanceId": "i-8vbdrjrxzt78****",
      "MemberUid": 0,
      "IntranetAddress": "192.168.XX.XX",
      "SyncStatus": "enable",
      "AliUid": 0,
      "ProtectStatus": "open",
      "InternetAddress": "192.0.XX.XX",
      "BindInstanceId": "i-8vbdrjrxzt78****",
      "RegionID": "cn-hangzhou",
      "RegionStatus": "enable",
      "ResourceType": "EIP",
      "IpVersion": 4,
      "SgStatus": "block",
      "Note": "REGION_NOT_SUPPORT",
      "Name": "instance01",
      "CreateTimeStamp": "2023-02-28 10:29:58",
      "NewResourceTag": "discovered in 1 hour",
      "SensitiveDataStatus": "open",
      "Last7DayOutTrafficBytes": 0
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorDBSelect	An error occurred while querying database.	内部错误：数据库查询错误

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

变更历史

变更时间	变更内容概要	操作
2023-08-29	OpenAPI 错误码发生变更	查看变更详情