全部产品
Search
文档中心

云防火墙:DescribeOutgoingDestinationIP - 查询主动外联的目的IP信息

更新时间:Oct 23, 2024

查询主动外联的目的IP信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh
StartTimestring

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

1656837360
EndTimestring

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

1656923760
PageSizestring

设置分页查询每页包含多少条结果。

默认值为 6,表示每页包含 6 条结果。最大值为 10。

10
CurrentPagestring

设置分页查询返回第几页数据。

默认值为 1,表示返回第 1 页数据。

1
CategoryIdstring

产品分类 ID。默认值为空,取值:

  • All :全部分类
  • RiskDomain :风险域名分类
  • RiskIP :风险 IP 分类
  • AliYun :云产品分类
  • NotAliYun :非云产品分类
All
DstIPstring

主动外联域名的目的 IP。

10.0.XX.XX
PublicIPstring

外联 ECS 的公网 IP。

192.0.XX.XX
PrivateIPstring

外联 ECS 的私网 IP。

192.168.XX.XX
Portstring

端口号。

80
Sortstring

按照指定的字段排序。取值:

  • SessionCount(默认值):请求次数。
  • TotalBytes:总流量数。
SessionCount
Orderstring

排序方式。取值:

  • asc:升序。
  • desc(默认):降序。
desc
TagIdNewstring

情报标签 ID。取值:

  • AliYun:阿里云产品
  • RiskDomain:风险域名
  • RiskIP:风险 IP
  • TrustedDomain:信誉网站
  • AliPay:支付宝
  • DingDing:钉钉
  • WeChat:微信
  • QQ:腾讯 QQ
  • SecurityService:安全服务
  • Microsoft:微软
  • Amazon:亚马逊
  • Pan:网盘
  • Map:地图
  • Code:代码托管
  • SystemService:系统服务
  • Taobao:淘宝
  • Google:谷歌
  • ThirdPartyService:第三方平台服务
  • FirstFlow:首次
  • Downloader:恶意下载
  • Alexa Top1M:热门网站
  • Miner:矿池
  • Intelligence:威胁情报
  • DDoS:DDoS 木马
  • Ransomware:勒索软件
  • Spyware:间谍软件
  • Rogue:流氓软件
  • Botnet:僵尸网络
  • Suspicious:可疑网站
  • C&C:远控
  • Gang:团伙
  • CVE:漏洞 CVE
  • Backdoor:木马后门
  • Phishing:钓鱼网站
  • APT:APT 攻击
  • Supply Chain Attack:供应链攻击
  • Malicious software:恶意软件
AliYun
ApplicationNamestring

访问控制策略支持的应用类型。取值:

  • FTP
  • HTTP
  • HTTPS
  • Memcache
  • MongoDB
  • MQTT
  • MySQL
  • RDP
  • Redis
  • SMTP
  • SMTPS
  • SSH
  • SSL_No_Cert
  • SSL
  • VNC
说明 支持的应用类型取值与协议类型(Proto)取值存在依赖关系。Proto 为 TCP 协议时,ApplicationNameList 支持选择以上所有应用类型。当 ApplicationNameList 和 ApplicationName 同时传值时,以 ApplicationNameList 为准。
FTP

返回参数

名称类型描述示例值
object
TotalCountinteger

外联 IP 的总数量。

50
RequestIdstring

本次调用请求的 ID。

F0F82705-CFC7-5F83-86C8-A063892F****
DstIPListarray<object>

主动外联的 IP 列表。

DstIPDataobject

主动外联的 IP 列表。

AclCoveragestring

是否覆盖访问控制策略。取值:

  • Uncovered:未覆盖。

  • FullCoverage:已覆盖。

Uncovered
DstIPstring

主动外联域名的目的 IP。

10.0.XX.XX
AclRecommendDetailstring

ACL 的建议信息。

建议放行
HasAclRecommendboolean

是否有推荐 ACL。取值:

  • true:是。

  • false:否。

true
InByteslong

入方向的流量。单位:Byte。

472
CategoryNamestring

产品的分类名称。取值:

  • 阿里云产品

  • 非阿里云产品

阿里云产品
RuleNamestring

ACL 规则名称。

默认规则
RuleIdstring

ACL 规则 UUID。

fadsfd-dfadf-df****
SessionCountlong

请求次数。

4
GroupNamestring

规则的组名称。

规则_test
SecuritySuggeststring

主动外联域名的安全策略。取值:

  • pass:放行。

  • alert:拒绝。

  • drop:观察。

pass
OutByteslong

出方向的流量。单位:Byte。

965
AclStatusstring

访问控制策略的健康状态。取值:

  • Normal:健康。
  • Abnormal:不健康。
Normal
IsMarkNormalboolean

是否加入白名单。取值:

  • true:已加入。

  • false:未加入。

true
CategoryIdstring

产品分类 ID。取值:

  • Aliyun:阿里云产品。

  • NotAliyun:非阿里云产品。

Aliyun
TagListarray<object>

标签列表。

tagobject

标签列表。

RiskLevelinteger

风险评估等级。取值:

  • 1:低危。
  • 2:中危。
  • 3:高危。
1
TagNamestring

情报标签名称。

放行标签
TagIdstring

情报标签 ID。

AliYun
TagDescribestring

情报标签的描述。

放行标签
ClassIdstring

情报标签的分类。取值:

  • Suspicious:可疑。
  • Malicious:恶意。
  • Trusted:信任。
Trusted
ApplicationPortListarray<object>

应用端口列表。

说明 列表仅展示前 99 个应用端口。当外联应用端口超过 99 个时,仅展示前 99 条数据。
appPortobject

端口列表。

Portinteger

应用的端口。

80
ApplicationNamestring

访问控制策略支持的应用类型。取值:

  • FTP
  • HTTP
  • HTTPS
  • Memcache
  • MongoDB
  • MQTT
  • MySQL
  • RDP
  • Redis
  • SMTP
  • SMTPS
  • SSH
  • SSL_No_Cert
  • SSL
  • VNC
说明 支持的应用类型取值与协议类型(Proto)取值存在依赖关系。Proto 为 TCP 协议时,ApplicationNameList 支持选择以上所有应用类型。当 ApplicationNameList 和 ApplicationName 同时传值时,以 ApplicationNameList 为准。
HTTP
CategoryClassIdstring

情报标签的分类。取值:

  • Suspicious:可疑。
  • Malicious:恶意。
  • Trusted:信任。
Trusted
SecurityReasonstring

安全原因。

智能策略:该目的域名所属组织为阿里云计算有限公司,主要业务为阿里云,未发现安全风险,可用于配置外联白名单。
TotalBytesstring

总流量。单位:byte。

800
HasAclstring

是否有访问控制规则。取值:

  • true:有。
  • false :没有。
true
AddressGroupListarray<object>

地址簿信息。

addressGroupobject
AddressGroupUUIDstring

地址簿唯一标识。

f04ac7ce-628b-4cb7-be61-310222b7****
AddressGroupNamestring

地址簿名称。

IP地址簿
AssetCountlong

主动外联的资产总数。

20
PrivateAssetCountlong

主动外联的私网资产总数。

20
LocationNamestring

区域名。

山东省青岛市

示例

正常返回示例

JSON格式

{
  "TotalCount": 50,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "DstIPList": [
    {
      "AclCoverage": "Uncovered",
      "DstIP": "10.0.XX.XX",
      "AclRecommendDetail": "建议放行",
      "HasAclRecommend": true,
      "InBytes": 472,
      "CategoryName": "阿里云产品",
      "RuleName": "默认规则",
      "RuleId": "fadsfd-dfadf-df****",
      "SessionCount": 4,
      "GroupName": "规则_test",
      "SecuritySuggest": "pass",
      "OutBytes": 965,
      "AclStatus": "Normal",
      "IsMarkNormal": true,
      "CategoryId": "Aliyun",
      "TagList": [
        {
          "RiskLevel": 1,
          "TagName": "放行标签",
          "TagId": "AliYun",
          "TagDescribe": "放行标签",
          "ClassId": "Trusted"
        }
      ],
      "ApplicationPortList": [
        {
          "Port": 80,
          "ApplicationName": "HTTP"
        }
      ],
      "CategoryClassId": "Trusted",
      "SecurityReason": "智能策略:该目的域名所属组织为阿里云计算有限公司,主要业务为阿里云,未发现安全风险,可用于配置外联白名单。",
      "TotalBytes": "800",
      "HasAcl": "true",
      "AddressGroupList": [
        {
          "AddressGroupUUID": "f04ac7ce-628b-4cb7-be61-310222b7****",
          "AddressGroupName": "IP地址簿"
        }
      ],
      "AssetCount": 20,
      "PrivateAssetCount": 20,
      "LocationName": "山东省青岛市"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorAliUidAliuid invalid.aliuid无效
400ErrorTimeErrorThe time is invalid.时间选择错误
400ErrorIpFormatThe IP address is invalid.无效的IP
400ErrorDBSelectErrorA database select error occurred.内部错误:数据库查询错误
400ErrorPortErrorThe port is invalid.无效的端口
400ErrorSecuritySuggestThe security suggest is invalid.无效的security suggest
400ErrorSortErrorThe sort is invalid.无效的排序字段
400ErrorOrderFailedThe order is invalid.无效的order
400ErrorPageNoEither page number or page size is invalid.无效的page number 或者 page size
400ErrorIntervalErrorThe interval is invalid.无效的时间间隔
400ErrorDataTypeErrorThe data type is invalid.无效的数据类型
400ErrorMarshalJSONinternal error.内部错误。

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

变更历史

变更时间变更内容概要操作
2024-09-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-09-06OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2022-07-07新增 OpenAPI查看变更详情