Query scanned web directories by using DescribeWebPath - Security Center - Alibaba Cloud - Security Center

Queries custom web directories for security alerts.

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-sas:DescribeWebPath

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The alert configuration type. Valid values: web_path.	web_path
CurrentPage	integer	No	The page number of the current page in a paged query. Paging is used to display results.	1
PageSize	integer	No	The maximum number of entries per page in a paged query. Paging is used to display results.	20

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in a paged query. Paging is used to display results.	1
PageSize	integer	The maximum number of entries per page in a paged query. Paging is used to display results.	20
RequestId	string	The ID of the request. The China Chinese Cloud generates a unique identifier for each request, which can be used for troubleshooting and diagnostics.	B37C9052-A73E-4707-A024-92477028****
TotalCount	integer	The total number of entries returned.	2
Count	integer	The number of entries on the current page.	2
ConfigList	array<object>	The list of web paths.
	array<object>	The web directory.
WebPath	string	The web directory.	/root/www****
WebPathType	string	The type of the web path. Valid values: def: automatically identified by the system. customize: manually added.	def
TargetList	array<object>	The list of servers on which the web directory takes effect.
	object	The web directory.
Target	string	The object.	82048187-bb9b-4e19-8320-7b4ddb97****
TargetType	string	The object type. Valid values: uuid	uuid

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "PageSize": 20,
  "RequestId": "B37C9052-A73E-4707-A024-92477028****",
  "TotalCount": 2,
  "Count": 2,
  "ConfigList": [
    {
      "WebPath": "/root/www****",
      "WebPathType": "def",
      "TargetList": [
        {
          "Target": "82048187-bb9b-4e19-8320-7b4ddb97****",
          "TargetType": "uuid"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.