查询防护目录关联服务器

最近更新时间: 2026-10-14 00:10:50

1. 接口描述

接口请求域名： cwp.api3.fincloud.tencent.com。

查询防护目录关联服务器列表信息

默认接口请求频率限制：20次/秒。

接口更新时间：2022-05-20 15:13:13。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeProtectDirRelatedServer
Version	是	否	String	公共参数，本接口取值：2018-02-28
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
By	否	否	String	排序值示例值： LatestProtectTime
Filters	否	否	Array of Filter	过滤参数 ProtectStatus 示例值：查看
Id	是	否	String	唯一ID 示例值： 1
Limit	是	否	Uint64	分页条数最大100条示例值： 10
Offset	是	否	Uint64	偏移量示例值： 0
Order	否	否	String	排序方式示例值： asc

3. 输出参数

参数名称	类型	描述
List	Array of ProtectDirRelatedServer	网站关联服务器列表信息示例值：查看
ProtectServerCount	Uint64	已开启防护总数示例值： 12
TotalCount	Uint64	总数示例值： 12
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
MissingParameter	缺少参数错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 示例

输入示例

POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeProtectDirRelatedServer
<Public request parameters>

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

输出示例

{"Response":{"List":[{"Authorization": true,"AutoRestoreSwitchStatus": 1,"Exception": 0,"ExceptionMessage":"Starting","HostIp":"www.example.com","HostName":"Directory Name 1","Id":"/temp","MachineExtraInfo":{"HostName":"demo-instance","InstanceID":"ins-1002","NetworkName":"vpc-1002","NetworkType": 1,"PrivateIP":"www.example.com","WanIP":"1.1.1"},"MachineOs":"Linux","Progress": 10,"ProtectStatus": 1,"ProtectSwitch": 1,"Quuid":"Server Unique ID","RelateDirNum": 1}],"ProtectServerCount": 1,"RequestId":"7eb47586-e1e9 - 40eb-a3e1-bc73 cf1e475f","TotalCount": 1}}