1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取防卸载主机列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePreventUninstallHost。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-e74488e0ba0cd8fe"] |
| Filters.N | 否 | Array of EDRFilter | Name - string - 是否必填:否 - 主机名 InstanceId - string - 是否必填:否 - 实例ID PublicIp - string - 是否必填:否 - 公网IP PrivateIp - string - 是否必填:否 - 私网IP |
| Limit | 否 | Integer | 限制条数,默认10,最大100 示例值:10 |
| Offset | 否 | Integer | 偏移量,默认0 示例值:0 |
| Order | 否 | String | 排序方式: [ASC:升序|DESC:降序] 示例值:asc |
| By | 否 | String | 可选排序列: [Id] 示例值:Id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值:28 |
| List | Array of ClientSettingHost | 主机列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取卸载防护配置主机
获取卸载防护配置主机
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreventUninstallHost
<公共请求参数>
{}
输出示例
{
"Response": {
"List": [
{
"FunctionStatus": 1,
"Id": 604721361,
"InstanceId": "eks-gke2ehqw",
"MachineExtraInfo": {
"HostName": "tke-np-5evz8w08-worker",
"InstanceID": "eks-gke2ehqw",
"NetworkName": "vpc-cwcsulhn",
"NetworkType": 1,
"PrivateIP": "172.17.1.183",
"WanIP": ""
},
"Message": "",
"MessageDesc": "",
"Name": "tke-np-5evz8w08-worker",
"PrivateIp": "172.17.1.183",
"PublicIp": "",
"Quuid": "361b9679-7321-40ff-a520-7836112661ea",
"RegionInfo": {
"Region": "ap-guangzhou",
"RegionCode": "gz",
"RegionId": 1,
"RegionName": "华南地区(广州)",
"RegionNameEn": "South China (Guangzhou)"
},
"Status": "OFFLINE",
"VpcId": "vpc-cwcsulhn"
},
{
"FunctionStatus": 1,
"Id": 604721360,
"InstanceId": "ins-hwi2xwnd",
"MachineExtraInfo": {
"HostName": "tke_cls-mtdct307_worker",
"InstanceID": "ins-hwi2xwnd",
"NetworkName": "vpc-dwljk8d4",
"NetworkType": 1,
"PrivateIP": "10.255.255.189",
"WanIP": "43.136.185.218"
},
"Message": "",
"MessageDesc": "",
"Name": "tke_cls-mtdct307_worker",
"PrivateIp": "10.255.255.189",
"PublicIp": "43.136.185.218",
"Quuid": "8a1b701c-1f7e-47bf-8e22-d5c3e5dcb1b1",
"RegionInfo": {
"Region": "ap-chengdu",
"RegionCode": "cd",
"RegionId": 16,
"RegionName": "西南地区(成都)",
"RegionNameEn": "Southwestxa0China (Chengdu)"
},
"Status": "ONLINE",
"VpcId": "vpc-dwljk8d4"
}
],
"RequestId": "17dbce4c-a9b3-473d-968a-bc82eaabfa73",
"Total": 2
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |