调用DescribeLogDeliveryConfigs查询日志外发投递配置-Web应用防火墙-阿里云

查询所有混合云日志外发投递配置。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeLogDeliveryConfigs

list

*全部资源

*

acs:ResourceGroupId

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。	waf-cn-zz11sr5****
DeliveryNameLike	string	否	要查询的外发投递配置名称。您可以设置该参数，模糊查询某个外发投递配置。	test
DeliveryType	string	否	要查询的外发投递配置类型。取值为： syslog：表示外发到 syslog 服务。 kafka：表示外发到 kafka 服务。	kafka
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
NextToken	string	否	下一页查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。首页查询无需传入。	AAAAAINZ+8pH1oQnusEu1tGAc8is
MaxResults	integer	否	分页查询时每页个数。取值范围为：1-50，默认值为 20。	20

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID。	2EFCFE18-78F8-5079-B312-07***48B
DeliveryConfigs	array<object>	外发投递配置信息。
	object	外发投递配置。
DeliveryName	string	外发投递配置名称。	test1
DeliveryDetail	string	外发投递配置内容，以一系列参数构造的 JSON 格式转化成字符串。说明与 CreateLogDeliveryConfig 接口的 DeliveryDetail 参数相同。相关描述，请参见 CreateLogDeliveryConfig 接口的外发投递配置内容参数描述。	详见各个外发投递类型的内容详情
DeliveryType	string	外发投递配置类型。取值为： syslog：表示外发到 syslog 服务。 kafka：表示外发到 kafka 服务。	kafka
NextToken	string	下一页查询凭证（Token），如果有下一页，则该字段有返回值。说明该参数只要返回值，则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据，直到无返回值，表示获取到了所有的数据。	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	分页查询时每页个数。取值范围为：1-50，默认值为 20。	20
TotalCount	integer	返回结果的总数。	5

示例

正常返回示例

JSON格式

{
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "DeliveryConfigs": [
    {
      "DeliveryName": "test1",
      "DeliveryDetail": "详见各个外发投递类型的内容详情",
      "DeliveryType": "kafka"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 20,
  "TotalCount": 5
}

错误码

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

变更历史

更多信息，参考变更详情。