DescribeWebPath - Security Center - Alibaba Cloud Documentation Center

Queries the custom web directories that are scanned based on the alerting feature.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeWebPath	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The type of the alert configuration. Valid values: web_path	web_path
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	20

Response parameters

Parameter	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	B37C9052-A73E-4707-A024-92477028****
TotalCount	integer	The total number of entries returned.	2
Count	integer	The number of entries returned on the current page.	2
ConfigList	array<object>	An array that consists of the paths to the web directories.
config	object	The web directory.
WebPath	string	The path to the web directory.	/root/www****
WebPathType	string	The path type of the web directory. Valid values: def: automatically identified customize: manually added	def
TargetList	array<object>	An array consisting of the servers on which the web directories are scanned.
target	object	The web directory.
Target	string	The object.	82048187-bb9b-4e19-8320-7b4ddb97****
TargetType	string	The object type. Valid values: uuid	uuid

Examples

Sample success responses

JSONformat

{
  "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
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history