DescribeOutgoingDestination - 查询外联目的

更新时间:
复制 MD 格式

查询外联目的。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeOutgoingDestination

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SourceIp deprecated

string

访问源的 IP 地址。(该字段已经废弃)

106.3.198.XXX

Lang

string

接收消息的语言类型。

zh

StartTime

string

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

1749657600

EndTime

string

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

1749089441

PageSize

string

当前页数。

10

CurrentPage

string

当前页码。

1

CategoryId

string

分类 ID。

枚举值:

  • RiskDomain :

    风险域名

  • AliYun :

    阿里云产品

  • NotAliYun :

    非阿里云产品

AliYun

TagId

string

标签 ID

FirstFlow

SecuritySuggest

string

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

枚举值:

  • drop :

    观察

  • alert :

    拒绝

  • pass :

    放行

pass

AclCoverage

string

策略覆盖情况。

FullCoverage

DstIP

string

旧版目标 IP 参数。

说明

POP 网关会正常透传该参数,但本接口后端未读取它,传入不会产生任何过滤效果。按 IP 筛选请使用 PublicIP 或 PrivateIP;仅提供 DstIP 时,因缺少有效的 IP 过滤参数,返回 MissingParameter.IpFilter(-340415)。

47.100.111XXX

PublicIP

string

公网 IP。

说明

PublicIP 和 PrivateIP 至少需填写一个。

47.96.74.XXX

PrivateIP

string

私网 IP。

说明

PublicIP 和 PrivateIP 至少需填写一个。

10.111.53XXX

ApplicationName

string

应用名称。

HTTP

Port

string

端口号。

3306

Sort

string

按照指定的字段排序。

枚举值:

  • InBytes :

    InBytes

  • TotalBytes :

    TotalBytes

  • SessionCount :

    SessionCount

  • OutBytes :

    OutBytes

InBytes

Order

string

排序方式。

desc

IsAITraffic

string

是否仅统计访问 AI 服务的流量。默认取值为否。

枚举值:

  • false :

  • true :

true

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

总条数。

42

RequestId

string

返回结果的请求 ID。

A2845BA9-1642-5B27-9F04-8014DD94****

DstList

array<object>

目的地址信息。

array<object>

目的地址信息。

DstIP

string

目的 ip。

101.6.15.XXX

AclRecommendDetail

string

ACL 推荐内容。

RecommendedRelease

HasAclRecommend

boolean

是否有推荐 ACL。

枚举值:

  • false :

  • true :

false

InBytes

integer

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

0

DstType

string

目标类型。

domain

CategoryName

string

产品的分类名称。

categor_test

DstDomain

string

目的域名。

example.com

SessionCount

integer

会话数。

10

GroupName

string

分组名称。

group-name

OutBytes

integer

出流量,单位 Byte。

0

AclStatus

string

策略状态。

枚举值:

  • Normal :

    健康

  • Abnormal :

    异常

Normal

CategoryId

string

分类 ID。

枚举值:

  • RiskDomain :

    风险域名

  • AliYun :

    阿里云产品

  • NotAliYun :

    非阿里云产品

AliYun

IsMarkNormal

boolean

是否被用户手动标记为正常。

枚举值:

  • false :

  • true :

false

TagList

array<object>

标签列表。

object

标签列表。

RiskLevel

integer

风险评估等级。

枚举值:

  • 0 :

    无风险

  • 1 :

    低风险

  • 2 :

    中风险

  • 3 :

    高风险

1

TagName

string

标签名。

verify

TagId

string

标签 ID。

FirstFlow

TagDescribe

string

标签描述。

tag-describe

Business

string

域名业务。

example.com

示例

正常返回示例

JSON格式

{
  "TotalCount": 42,
  "RequestId": "A2845BA9-1642-5B27-9F04-8014DD94****",
  "DstList": [
    {
      "DstIP": "101.6.15.XXX",
      "AclRecommendDetail": "RecommendedRelease",
      "HasAclRecommend": false,
      "InBytes": 0,
      "DstType": "domain",
      "CategoryName": "categor_test",
      "DstDomain": "example.com",
      "SessionCount": 10,
      "GroupName": "group-name",
      "OutBytes": 0,
      "AclStatus": "Normal",
      "CategoryId": "AliYun",
      "IsMarkNormal": false,
      "TagList": [
        {
          "RiskLevel": 1,
          "TagName": "verify",
          "TagId": "FirstFlow",
          "TagDescribe": "tag-describe"
        }
      ],
      "Business": "example.com"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorAliUid Aliuid invalid. aliuid无效
400 ErrorTimeError The time is invalid. 时间选择错误
400 ErrorIpFormat The IP address is invalid. 无效的IP
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 ErrorDBSelectError A database select error occurred. 内部错误:数据库查询错误
400 ErrorDataTypeError The data type is invalid. 无效的数据类型
400 MissingParameter.IpFilter At least one IP filter parameter (PublicIP, DstIP, SourceIp, or PrivateIP) is required.
400 InvalidParameter.PublicIP The PublicIP parameter value is not a valid IP address.

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

变更历史

更多信息,参考变更详情