DescribeUserApiRequest - 查询API接口的流量统计_Web应用防火墙(WAF)-阿里云帮助中心

查询API接口的流量统计。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeUserApiRequest	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-zxu38***
Domain	string	否	API 接口所属的域名或 IP。注意该参数以弃用，请使用 ApiId 查询。	c.***.com
ApiFormat	string	否	API 接口。注意该参数以弃用，请使用 ApiId 查询。	/api/v1/know
Type	string	否	统计类型。取值： api_ip：表示总流量。 api_cross_border_ip：表示跨境流量。 api_bot_ip：表示机器流量。 remote_region：表示地理位置统计。 client_id：表示客户端类型统计。 http_referer：表示 Referer 统计。 api_cnt：表示总调用量。 bot_cnt：表示机器请求调用量。 cross_border_cnt：表示跨境请求量。 api_freq：表示调用频次。	api_ip
ClusterId	string	否	混合云集群 ID。说明只针对混合云场景，您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。	428
ApiId	string	是	API 的 ID。	3799f0695c0d687f3295d132fe49bc14
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

返回参数

名称	类型	描述	示例值
	object	请求结果。
RequestId	string	请求 ID。	D13E4540-4432-5AD7-B216-6369512514F4
Requests	array<object>	统计列表。
request	object	统计信息。
Value	string	统计信息。包括： client_list：表示客户端工具。 ip：表示 IP 信息。 region_id：表示所属地域。 country_id：表示所属国家。	{ "client_list": [ "Unknown" ], "ip": "47.92.113.***", "region_id": "110000", "country_id": "CN" }
Count	long	统计数。	76

示例

正常返回示例

JSON格式

{
  "RequestId": "D13E4540-4432-5AD7-B216-6369512514F4",
  "Requests": [
    {
      "Value": "{\n    \"client_list\": [\n        \"Unknown\"\n    ],\n    \"ip\": \"47.92.113.***\",\n    \"region_id\": \"110000\",\n    \"country_id\": \"CN\"\n}",
      "Count": 76
    }
  ]
}

错误码

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