DescribeProtectDirRelatedServer

Download

Focus Mode

Font Size

Last updated: 2026-10-09 16:11:22

1. API Description

Domain name for API request: cwp.intl.tencentcloudapi.com.

Query the server list information associated with the protection directory.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeProtectDirRelatedServer.
Version	Yes	String	Common Params. The value used for this API: 2018-02-28.
Region	No	String	Common Params. This parameter is not required.
Id	Yes	String	Unique ID
Limit	Yes	Integer	Number of entries on each page. Maximum value: 100.
Offset	Yes	Integer	Offset.
Filters.N	No	Array of Filter	Filter parameter ProtectStatus
Order	No	String	Sorting method.
By	No	String	Sort value

3. Output Parameters

Parameter Name	Type	Description
List	Array of ProtectDirRelatedServer	Website-associated server list information
TotalCount	Integer	Total number
ProtectServerCount	Integer	Total number of protected instances
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: cwp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProtectDirRelatedServer
<Common request parameters>

{
    "Id": "/tmp",
    "Limit": 10,
    "Offset": 0
}

Output Example

{
    "Response": {
        "List": [
            {
                "MachineExtraInfo": {
                    "HostName": "demo-instance",
                    "InstanceID": "ins-1002",
                    "NetworkName": "vpc-1002",
                    "NetworkType": 1,
                    "PrivateIP": "1.1.1.1",
                    "WanIP": "1.1.1.1"
                },
                "Id": "/temp",
                "AutoRestoreSwitchStatus": 1,
"HostName": "Directory Name 1",
                "HostIp": "10.0.0.1",
                "MachineOs": "Linux",
                "RelateDirNum": 1,
                "ProtectSwitch": 1,
                "ProtectStatus": 1,
"Quuid": "Server unique ID"
                "Authorization": true,
                "Exception": 0,
                "Progress": 10,
"ExceptionMessage": "starting"
            }
        ],
        "RequestId": "7eb47586-e1e9-40eb-a3e1-bc73cf1e475f",
        "TotalCount": 1,
        "ProtectServerCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error
InvalidParameter
InvalidParameterValue
MissingParameter

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Workload Protection Platform