Tenant Cloud Security Cloud Workload Protection Platform Advanced Defense APIs DescribeServerRelatedDirInfo

DescribeServerRelatedDirInfo

Last Updated At: 2026-08-02 00:04:57

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to query the details of directories associated with a server.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-05-20 15:13:13.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeServerRelatedDirInfo
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
Id Yes No Uint64 Unique ID.
Example: 1

3. Output Parameters

Parameter name Type Description
HostIp String Server IP.
Example: 10.0.0.1
HostName String Server name.
Example: redis_node_cvm
ProtectDirNum Uint64 Number of protected directories.
Example: 1
ProtectFileNum Uint64 Number of protected files.
Example: 1
ProtectLinkNum Uint64 Number of protected soft links.
Example: 1
ProtectTamperNum Uint64 Number of web pages protected by anti-tampering.
Example: 1
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InternalError Internal error.
MissingParameter Missing parameter.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.