All Products
Search

This Product

    Web Application Firewall:DescribeApisecApiResources

    Document Center

    Web Application Firewall:DescribeApisecApiResources

    Last Updated:Jul 07, 2026

    Queries the list of API security assets.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-waf:DescribeApisecApiResources

    get

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the WAF instance.

    Note

    You can call DescribeInstance to obtain the ID of the current WAF instance.

    waf_v2_public_cn-u***gr20j
    ApiId

    string

    No

    The ID of the API.

    867ade***24ee6e205b8da82b8f84
    ApiFormat

    string

    No

    The API operation.

    /auth/login
    MatchedHost

    string

    No

    The domain name or IP address to which the API operation belongs.

    a.aliyun.com
    SensitiveType

    string

    No

    The type of sensitive data in the response.

    Note

    You can call DescribeApisecRules to obtain the supported sensitive data types.

    1004
    ApiStatus

    string

    No

    The status of the API. Valid values:

    • NewbornInterface: newly added.

    • OfflineInterface: inactive.

    • normal: normal.

    OfflineInterface
    StartTime

    string

    No

    The start time of the query, in UNIX timestamp (UTC) format. Unit: seconds.

    1681833600
    EndTime

    string

    No

    The end time of the query, in UNIX timestamp (UTC) format. Unit: seconds.

    1683388800
    OrderKey

    string

    No

    The name of the field used for sorting. Valid values:

    • allCnt: total access volume in the last 30 days.

    • botCnt: bot access volume in the last 30 days.

    • crossBorderCnt: cross-border access volume in the last 30 days.

    • abnormalNum: number of risks associated with the API.

    • eventNum: number of events associated with the API.

    • farthestTs: first discovery time.

    • lastestTs: most recent access time.

    allCnt
    OrderWay

    string

    No

    The sort order. Valid values:

    • desc: descending order (default).

    • asc: ascending order.

    desc
    PageNumber

    integer

    No

    The page number to return in a paging query. Default value: 1, which indicates that the first page is returned.

    1
    PageSize

    integer

    No

    The number of entries to return on each page in a paging query. Default value: 10, which indicates that each page contains 10 entries.

    10
    Follow

    integer

    No

    Specifies whether the API is followed. Valid values:

    • 1: followed.

    • 0: not followed.

    0
    ApiType

    string

    No

    The service object. Valid values:

    • PublicAPI: public service.

    • ThirdpartAPI: third-party collaboration.

    • InternalAPI: internal office.

    innerAPI
    ApiTag

    string

    No

    The business purpose of the API.

    Note

    You can call DescribeApisecRules to obtain the supported business purposes.

    SendMail
    SensitiveLevel

    string

    No

    The sensitivity level of the API. Valid values:

    • L1: high sensitivity.

    • L2: medium sensitivity.

    • L3: low sensitivity.

    • N: not sensitive.

    L3
    ApiMethod

    string

    No

    The request method of the API. Valid values:

    • GET: GET request.

    • POST: POST request.

    • HEAD: HEAD request.

    • PUT: PUT request.

    • DELETE: DELETE request.

    • CONNECT: CONNECT request.

    • PATCH: PATCH request.

    • OPTIONS: OPTIONS request.

    POST
    ClusterId

    string

    No

    The ID of the hybrid cloud cluster.

    Note

    This parameter applies only to hybrid cloud scenarios. You can call DescribeHybridCloudClusters to obtain hybrid cloud cluster information.

    740
    Note

    string

    No

    The remarks.

    loginApi
    RequestSensitiveType

    string

    No

    The type of sensitive information in the request.

    Note

    You can call DescribeApisecRules to obtain the supported sensitive information types.

    1004,1005
    AuthFlag

    string

    No

    Specifies whether the API has an authentication field. Valid values:

    • 0: has authentication.

    • 1: does not have authentication.

    0
    RegionId

    string

    No

    The region where the WAF instance is deployed. Valid values:

    • cn-hangzhou: the Chinese mainland.

    • ap-southeast-1: outside the Chinese mainland.

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    No

    The Alibaba Cloud resource group ID.

    rg-acfm***q

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    TotalCount

    integer

    The total number of entries returned.

    5
    RequestId

    string

    The request ID.

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

    array<object>

    The list of API assets.

    object

    The asset details.

    EventNum

    integer

    The number of security events associated with the API.

    2
    FarthestTs

    integer

    The time when the API asset was first discovered, in UNIX timestamp (UTC) format. Unit: seconds.

    1683388800
    ApiSensitive

    string

    The sensitive information involved in the API, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:

    • request_sensitive_list: the list of sensitive data types in the request.

    • response_sensitive_list: the list of sensitive data types in the response.

    • sensitive_list: the list of sensitive data types.

    • sensitive_level: the sensitivity level.

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

    string

    The API operation.

    /v1/etl/finddatabyvid
    ApiTag

    string

    The business purpose of the API.

    Note

    You can call DescribeApisecRules to obtain the supported business purposes.

    SendMail
    CrossBorderCnt

    integer

    The cross-border access volume in the last 30 days.

    2
    AuthFlag

    string

    Specifies whether the API has an authentication field. Valid values:

    • 0: has authentication.

    • 1: does not have authentication.

    1
    AllCnt

    integer

    The total access volume in the last 30 days.

    1683388800
    ApiMethod

    string

    The request method of the API. Valid values:

    • GET: GET request.

    • POST: POST request.

    • HEAD: HEAD request.

    • PUT: PUT request.

    • DELETE: DELETE request.

    • CONNECT: CONNECT request.

    • PATCH: PATCH request.

    • OPTIONS: OPTIONS request.

    POST
    LastestTs

    integer

    The most recent access time of the API asset, in UNIX timestamp (UTC) format. Unit: seconds.

    1683388800
    ApiStatus

    string

    The status of the API. Valid values:

    • NewbornInterface: newly added.

    • OfflineInterface: inactive.

    • normal: normal.

    NewbornInterface
    ApiSensitiveResponse

    string

    The sensitive data in the API response.

    ["1002","1005"]
    BotCnt

    integer

    The bot access volume in the last 30 days.

    2
    Follow

    integer

    Specifies whether the API is followed. Valid values:

    • 1: followed.

    • 0: not followed.

    1
    MatchedHost

    string

    The domain name or IP address to which the API operation belongs.

    a.aliyun.com
    ApiInfo

    string

    The API information, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:

    • param_num: the number of API parameters.

    • request_method: the request method.

    • protocol: the request protocol.

    • api_url: the request URL.

    • poc_payload: the request.

    • request: the request sample.

    • response: the response sample.

    • param: the request parameters.

    Note

    This field is returned only when the ApiId parameter is specified.

    { "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

    The number of risks associated with the API.

    2
    ApiType

    string

    The service object. Valid values:

    • PublicAPI: public service.

    • ThirdpartAPI: third-party collaboration.

    • InternalAPI: internal office.

    PublicAPI
    Note

    string

    The remarks.

    loginApi
    ApiId

    string

    The ID of the API.

    197b52abcd81d6a8bd4***e477
    Examples deprecated

    array

    The list of API samples.

    string

    The sample information, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:

    • param_num: the number of API parameters.

    • request_method: the request method.

    • protocol: the request protocol.

    • api_url: the request URL.

    • poc_payload: the request.

    • request: the request sample.

    • response: the response sample.

    • param: the request parameters.

    Note

    This field is returned only when the ApiId parameter is specified.

    { "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

    The sensitive data in the API request.

    ["1002","1005"]
    Resources

    array

    The list of protected objects corresponding to the asset.

    string

    The protected object corresponding to the asset.

    ***.top-waf
    AccountEventNum

    integer

    The number of account security events associated with the asset.

    1

    Examples

    Success response

    JSON format

    {
  "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": "loginApi",
      "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"
      ],
      "AccountEventNum": 1
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.