全部产品
Search
文档中心

Web 应用防火墙:DescribeLogServiceStatus - 查询日志采集状态

更新时间:May 14, 2024

查询已接入WAF进行防护的域名的日志采集状态(是否开启日志采集)。

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
waf-cn-zz11sr5****
Regionstring

日志服务地域 ID。取值:

  • cn:中国内地地区(默认)
  • cn-hongkong:海外地区
cn
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。默认为空,即属于默认资源组。

关于资源组的更多信息,请参见创建资源组

rg-acfm2pz25js****
PageNumberinteger

当前页码。默认值:1

1
PageSizeinteger

分页查询时每页的行数。默认值为 10

10
DomainNamesarray

要查询的域名列表。一次最多允许查询 10 个域名。不填写该参数表示查询所有域名。

说明 您可以调用 DescribeDomainNames 查询所有已经接入当前 WAF 实例进行防护的域名。
string

域名。

www.aliyunXXXX.com
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
TotalCountinteger

返回结果的总数。

63
RequestIdstring

本次请求的 ID。

D7861F61-5B61-46CE-A47C-6B19****5EB0
DomainStatusobject []

域名的日志采集状态(是否开启了日志采集)。

Domainstring

域名名称。

www.aliyun.com
SlsLogActiveinteger

该域名是否开启了日志采集。取值:

  • 1:表示已开启。
  • 0:表示未开启。
1

示例

正常返回示例

JSON格式

{
  "TotalCount": 63,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0",
  "DomainStatus": [
    {
      "Domain": "www.aliyun.com",
      "SlsLogActive": 1
    }
  ]
}

错误码

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