AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 Web应用防火墙 Web应用防火墙3.0 开发参考 API参考 API目录 API安全 DescribeApisecApiResources - 查询API安全资产列表

DescribeApisecApiResources - 查询API安全资产列表

更新时间：
产品详情
我的收藏

查询API安全资产列表。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeApisecApiResources

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

WAF 实例的 ID。

说明

您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。

waf_v2_public_cn-u***gr20j
ApiId

string

否

API 的 ID。

867ade***24ee6e205b8da82b8f84
ApiFormat

string

否

API 接口。

/auth/login
MatchedHost

string

否

API 接口所属的域名或 IP。

a.aliyun.com
SensitiveType

string

否

响应敏感数据类型。

说明

您可以调用 DescribeApisecRules 获取支持的敏感数据类型。

1004
ApiStatus

string

否

API 的状态。取值：

  • NewbornInterface：表示新增。

  • OfflineInterface：表示失活。

  • normal：表示正常。

OfflineInterface
StartTime

string

否

查询的开始时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

1681833600
EndTime

string

否

查询的结束时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

1683388800
OrderKey

string

否

排序字段的名称。取值：

  • allCnt：表示近 30 天总访问量。

  • botCnt：表示近 30 天机器访问量。

  • crossBorderCnt：表示近 30 天跨境访问量。

  • abnormalNum：表示 API 关联风险数量。

  • eventNum：表示 API 关联事件数量。

  • farthestTs：表示首次发现时间。

  • lastestTs：表示最近访问时间。

allCnt
OrderWay

string

否

排序的方式。取值：

  • desc：表示降序（默认）。

  • asc：表示升序。

desc
PageNumber

integer

否

分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。

1
PageSize

integer

否

分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。

10
Follow

integer

否

是否关注。取值：

  • 1：表示关注。

  • 0：表示未关注。

0
ApiType

string

否

服务对象。取值：

  • PublicAPI：表示公共服务。

  • ThirdpartAPI：表示三方合作。

  • InternalAPI：表示内部办公。

innerAPI
ApiTag

string

否

API 业务用途。

说明

您可以调用 DescribeApisecRules 获取支持的业务用途。

SendMail
SensitiveLevel

string

否

接口敏感等级。取值：

  • L1：表示高敏感。

  • L2：表示中敏感。

  • L3：表示低敏感。

  • N：表示非敏感。

L3
ApiMethod

string

否

API 的请求方法。取值：

  • GET：表示 GET 请求。

  • POST：表示 POST 请求。

  • HEAD：表示 HEAD 请求。

  • PUT：表示 PUT 请求。

  • DELETE：表示 DELETE 请求。

  • CONNECT：表示 CONNECT 请求。

  • PATCH：表示 PATCH 请求。

  • OPTIONS：表示 OPTIONS 请求。

POST
ClusterId

string

否

混合云集群 ID。

说明

只针对混合云场景，您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。

740
Note

string

否

备注信息。

登录API
RequestSensitiveType

string

否

请求敏感信息类型。

说明

您可以调用 DescribeApisecRules 获取支持的敏感信息类型。

1004,1005
AuthFlag

string

否

是否有鉴权字段。取值：

  • 0：表示有权限。

  • 1：表示无权限。

0
RegionId

string

否

WAF 实例所属地域。取值：

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

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

cn-hangzhou
ResourceManagerResourceGroupId

string

否

阿里云资源组 ID。

rg-acfm***q

返回参数

名称

类型

描述

示例值

object

请求结果。

TotalCount

integer

返回结果的总数。

5
RequestId

string

请求 ID。

2EFCFE18-78F8-5079-B312-07***48B
Data

array<object>

API 资产列表。

object

资产详情。

EventNum

integer

API 关联的安全事件数量。

2
FarthestTs

integer

API 资产首次发现时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

1683388800
ApiSensitive

string

API 涉及的敏感信息，以一系列参数构造的 JSON 格式转化成字符串。包括：

  • request_sensitive_list：表示请求敏感数据类型列表。

  • response_sensitive_list：表示响应敏感数据类型列表。

  • sensitive_list：表示敏感数据类型列表。

  • sensitive_level：表示敏感等级。

{ "sensitive_list": ["1003","1005"], "sensitive_level": "L2", "request_sensitive_list": ["1003"], "response_sensitive_list": ["1005"] }
ApiFormat

string

API 接口。

/v1/etl/finddatabyvid
ApiTag

string

API 业务用途。

说明

您可以调用 DescribeApisecRules 获取支持的业务用途。

SendMail
CrossBorderCnt

integer

近 30 天跨境访问量。

2
AuthFlag

string

是否有鉴权字段。取值：

  • 0：表示有权限。

  • 1：表示无权限。

1
AllCnt

integer

近 30 天总访问量。

1683388800
ApiMethod

string

API 的请求方法。取值：

  • GET：表示 GET 请求。

  • POST：表示 POST 请求。

  • HEAD：表示 HEAD 请求。

  • PUT：表示 PUT 请求。

  • DELETE：表示 DELETE 请求。

  • CONNECT：表示 CONNECT 请求。

  • PATCH：表示 PATCH 请求。

  • OPTIONS：表示 OPTIONS 请求。

POST
LastestTs

integer

API 资产最近访问时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

1683388800
ApiStatus

string

API 的状态。取值：

  • NewbornInterface：表示新增。

  • OfflineInterface：表示失活。

  • normal：表示正常。

NewbornInterface
ApiSensitiveResponse

string

API 响应敏感数据。

["1002","1005"]
BotCnt

integer

近 30 天机器访问量。

2
Follow

integer

是否关注。取值：

  • 1：表示关注。

  • 0：表示未关注。

1
MatchedHost

string

API 接口所属的域名或 IP。

a.aliyun.com
ApiInfo

string

API 相关信息，以一系列参数构造的 JSON 格式转化成字符串。包括：

  • param_num：表示 API 参数数量。

  • request_method：表示请求方式。

  • protocol：表示请求协议。

  • api_url：表示请求 URL。

  • poc_payload：表示请求。

  • request：表示请求样例。

  • response：表示响应样例。

  • param：表示请求参数。

说明

只有指定入参 ApiId 才会有该返回值。

{ "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
AbnormalNum

integer

API 关联的风险数量。

2
ApiType

string

服务对象。取值：

  • PublicAPI：表示公共服务。

  • ThirdpartAPI：表示三方合作。

  • InternalAPI：表示内部办公。

PublicAPI
Note

string

备注信息。

密码已修改
ApiId

string

API 的 ID。

197b52abcd81d6a8bd4***e477
Examples

array

API 样例列表。

string

样例信息，以一系列参数构造的 JSON 格式转化成字符串。包括：

  • param_num：表示 API 参数数量。

  • request_method：表示请求方式。

  • protocol：表示请求协议。

  • api_url：表示请求 URL。

  • poc_payload：表示请求。

  • request：表示请求样例。

  • response：表示响应样例。

  • param：表示请求参数。

说明

只有指定入参 ApiId 才会有该返回值。

{ "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
ApiSensitiveRequest

string

API 请求敏感数据。

["1002","1005"]
Resources

array

资产对应的防护对象列表。

string

资产对应的防护对象。

***.top-waf

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "Data": [
    {
      "EventNum": 2,
      "FarthestTs": 1683388800,
      "ApiSensitive": "{\n    \"sensitive_list\": [\"1003\",\"1005\"],\n    \"sensitive_level\": \"L2\",\n    \"request_sensitive_list\": [\"1003\"],\n    \"response_sensitive_list\": [\"1005\"]\n}",
      "ApiFormat": "/v1/etl/finddatabyvid",
      "ApiTag": "SendMail",
      "CrossBorderCnt": 2,
      "AuthFlag": "1",
      "AllCnt": 1683388800,
      "ApiMethod": "POST",
      "LastestTs": 1683388800,
      "ApiStatus": "NewbornInterface",
      "ApiSensitiveResponse": "[\"1002\",\"1005\"]",
      "BotCnt": 2,
      "Follow": 1,
      "MatchedHost": "a.aliyun.com",
      "ApiInfo": "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}",
      "AbnormalNum": 2,
      "ApiType": "PublicAPI",
      "Note": "密码已修改",
      "ApiId": "197b52abcd81d6a8bd4***e477",
      "Examples": [
        "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}"
      ],
      "ApiSensitiveRequest": "[\"1002\",\"1005\"]",
      "Resources": [
        "***.top-waf"
      ]
    }
  ]
}

错误码

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

变更历史

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

上一篇：DescribeApisecAbnormals - 查询API安全风险列表下一篇：ModifyApisecStatus - 修改API安全生效状态