All Products
Search
Document Center

Security Center:DescribeWebPath

Last Updated:Jul 26, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringNo

The type of the alert configuration. Valid values:

  • web_path
web_path
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

20

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

B37C9052-A73E-4707-A024-92477028****
TotalCountinteger

The total number of entries returned.

2
Countinteger

The number of entries returned on the current page.

2
ConfigListarray<object>

An array that consists of the paths to the web directories.

object

The web directory.

WebPathstring

The path to the web directory.

/root/www****
WebPathTypestring

The path type of the web directory. Valid values:

  • def: automatically identified
  • customize: manually added
def
TargetListarray<object>

An array consisting of the servers on which the web directories are scanned.

object

The web directory.

Targetstring

The object.

82048187-bb9b-4e19-8320-7b4ddb97****
TargetTypestring

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history