DescribeOutgoingDomain - 查询主动外联的域名信息 - 云防火墙

查询主动外联的域名信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求消息的语言类型。取值： zh（默认）：中文 en：英文	zh
StartTime	string	是	设置查询开始时间。使用秒级时间戳格式表示。	1656664560
EndTime	string	是	设置查询结束时间。使用秒级时间戳格式表示。	1656750960
PageSize	string	否	设置分页查询每页包含多少条结果。默认值为 6，表示每页包含 6 条结果。最大值为 100。	10
CurrentPage	string	否	设置分页查询返回第几页数据。默认值为 1，表示返回第 1 页数据。	1
CategoryId	string	否	产品分类。默认值：空。取值： All ：全部分类 RiskDomain：风险域名分类 RiskIP ：风险 IP 分类 AliYun ：云产品分类 NotAliYun ：非云产品分类	All
Domain	string	否	主动外联的域名。	www.aliyundoc.com
PublicIP	string	否	外联 ECS 的公网 IP。	192.0.XX.XX
Sort	string	否	按照指定的字段排序。取值： SessionCount（默认值）：请求次数 TotalBytes：总流量数	SessionCount
Order	string	否	排序方式。取值： asc：升序 desc（默认）：降序	desc
TagIdNew	string	否	情报标签 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

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	外联域名的总数量。	132
RequestId	string	本次调用请求的 ID。	F0F82705-CFC7-5F83-86C8-A063892F****
DomainList	array<object>	外联域名列表。
Data	object	外联域名列表。
AclCoverage	string	访问控制策略是否覆盖。取值： Uncovered：未覆盖 FullCoverage：已覆盖	Uncovered
Domain	string	主动外联的域名。	www.aliyundoc.com
AclRecommendDetail	string	ACL 推荐内容。	建议放行
HasAclRecommend	boolean	是否有推荐 ACL。取值： true：是 false：否	true
InBytes	long	入方向的流量。	3214
CategoryName	string	产品的分类名称。取值：阿里云产品非阿里云产品	阿里云产品
RuleName	string	ACL 规则名称。	默认规则
RuleId	string	ACL 规则 ID。	add-dfadf-f****
SessionCount	long	请求次数。	12
GroupName	string	规则的组名称。	外量地址组
SecuritySuggest	string	主动外联域名的安全策略。取值： pass：放行 alert：观察 drop：拒绝	pass
OutBytes	long	出方向的流量。	4582
AclStatus	string	访问控制策略的健康状态。取值： Normal：健康 Abnormal：不健康	Normal
IsMarkNormal	boolean	外联域名是否标记为正常。取值： true：正常 false：不正常	true
CategoryId	string	产品分类 ID。取值： Aliyun：阿里云产品 NotAliyun：非阿里云产品	Aliyun
AddressGroupUUID	string	地址簿 UUID。	fdad-fdafa-dafa-dfa****
AddressGroupName	string	地址簿的名称。	外联地址簿
CategoryClassId	string	情报标签的分类。取值： Suspicious：可疑 Malicious：恶意 Trusted：信任	Trusted
Business	string	网站业务。	阿里云
HasAcl	string	是否已有`ACL`覆盖此域名管控。取值： true：有 false ：没有	true
Organization	string	组织名称。	阿里云计算有限公司
SecurityReason	string	安全原因。	智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。
TotalBytes	string	总流量。单位：byte。	800
TagList	array<object>	标签列表。
tag	object
RiskLevel	integer	风险评估等级，取值： 1：低危 2：中危 3：高危	3
TagName	string	标签名称。	加白标签
TagId	string	情报标签 ID。	AliYun
TagDescribe	string	标签描述。	加白标签
ClassId	string	情报标签的分类。取值： Suspicious：可疑 Malicious：恶意 Trusted：信任	Trusted
ApplicationNameList	array	应用名称。
applicationNameList	string	应用名称列表。	HTTP
AssetCount	long	主动外联的资产总数。	20
PrivateAssetCount	long	主动外联的私网资产总数。	20

示例

正常返回示例

JSON格式

{
  "TotalCount": 132,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "DomainList": [
    {
      "AclCoverage": "Uncovered",
      "Domain": "www.aliyundoc.com",
      "AclRecommendDetail": "建议放行",
      "HasAclRecommend": true,
      "InBytes": 3214,
      "CategoryName": "阿里云产品",
      "RuleName": "默认规则",
      "RuleId": "add-dfadf-f****",
      "SessionCount": 12,
      "GroupName": "外量地址组",
      "SecuritySuggest": "pass",
      "OutBytes": 4582,
      "AclStatus": "Normal",
      "IsMarkNormal": true,
      "CategoryId": "Aliyun",
      "AddressGroupUUID": "fdad-fdafa-dafa-dfa****",
      "AddressGroupName": "外联地址簿",
      "CategoryClassId": "Trusted",
      "Business": "阿里云",
      "HasAcl": "true",
      "Organization": "阿里云计算有限公司",
      "SecurityReason": "智能策略：该目的域名所属组织为阿里云计算有限公司，主要业务为阿里云，未发现安全风险，可用于配置外联白名单。",
      "TotalBytes": "800",
      "TagList": [
        {
          "RiskLevel": 3,
          "TagName": "加白标签",
          "TagId": "AliYun",
          "TagDescribe": "加白标签",
          "ClassId": "Trusted"
        }
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "AssetCount": 20,
      "PrivateAssetCount": 20
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorAliUid	Aliuid invalid.	aliuid无效
400	ErrorTimeError	The time is invalid.	时间选择错误
400	ErrorDBSelectError	A database select error occurred.	内部错误：数据库查询错误
400	ErrorIntervalError	The interval is invalid.	无效的时间间隔
400	ErrorIpFormat	The IP address is invalid.	无效的IP
400	ErrorSecuritySuggest	The security suggest is invalid.	无效的security suggest
400	ErrorSortError	The sort is invalid.	无效的排序字段
400	ErrorOrderFailed	The order is invalid.	无效的order
400	ErrorPageNo	Either page number or page size is invalid.	无效的page number 或者 page size
400	ErrorDomainName	The domain name is invalid.	无效的域名
400	ErrorDataTypeError	The data type is invalid.	无效的数据类型
400	ErrorMarshalJSON	internal error.	内部错误。

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

变更历史

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