查询云防火墙防护的资产的信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cloudfirewall:DescribeAssetList | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 接收消息的语言类型。取值:
| zh |
CurrentPage | string | 是 | 分页查询时,设置当前页的页码。 | 1 |
PageSize | string | 是 | 分页查询时,设置每页包含云防火墙防护资产的数量。 | 10 |
RegionNo | string | 否 | 云防火墙所在的地域 ID。 说明
关于云防火墙支持地域的详细信息,请参见支持的地域。
| cn-hangzhou |
Status | string | 否 | 云防火墙状态。取值:
说明
不设置该参数表示查询所有防火墙状态。
| open |
SearchItem | string | 否 | 资产的 IP 或者实例 ID。 | 192.0.XX.XX |
Type | string | 否 | 本参数已废弃。 | eip |
ResourceType | string | 否 | 资产类型。取值:
| EIP |
SgStatus | string | 否 | 安全组策略状态。取值:
说明
不设置该参数表示查询所有安全组策略状态。
| pass |
IpVersion | string | 否 | 云防火墙防护的资产的 IP 版本。取值:
| 4 |
MemberUid | long | 否 | 云防火墙成员账号的 UID。 | 258039427902**** |
UserType | string | 否 | 用户类型。取值:
| buy |
NewResourceTag | string | 否 | 资产发现的时间。取值:
| discovered in 1 hour |
返回参数
示例
正常返回示例
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": "",
"Last7DayOutTrafficBytes": 0
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ErrorDBSelect | An error occurred while querying database. | 内部错误:数据库查询错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-08-29 | OpenAPI 错误码发生变更 | 查看变更详情 |