1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
用于网页防篡改获取区域主机列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMachineList。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
MachineType | 是 | String | 云主机类型。 示例值:CVM |
MachineRegion | 是 | String | 机器所属地域。如:ap-guangzhou,ap-shanghai 示例值:ap-guangzhou |
Limit | 否 | Integer | 返回数量,默认为10,最大值为100。 示例值:10 |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Filters.N | 否 | Array of AssetFilters | 过滤条件。 每个过滤条件只支持一个值,暂不支持多个值“或”关系查询 示例值:[{"Keywords":["CVE"]}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Machines | Array of Machine | 主机列表 示例值:[ { "MachineName": "stone", "MachineOs": "Windows", "MachineStatus": "ONLINE", "Uuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76", "Quuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76", "VulNum": 0, "MachineIp": "172.16.20.1", "IsProVersion": true, "MachineWanIp": "1.2.2.3", "PayMode": "", "MalwareNum": 0, "Tag": [ { "Rid": 0, "Name": "tag1", "TagId": 1 } ], "BaselineNum": 0, "CyberAttackNum": 0, "SecurityStatus": "SAFE", "InvasionNum": 0, "RegionInfo": { "RegionCode": "gz", "Region": "ap-guangzhuo", "RegionId": 1, "RegionName": "广州", "RegionNameEn": "chine guangzhou" }, "InstanceState": "", "LicenseStatus": 1, "ProjectId": 0, "HasAssetScan": 1, "MachineType": "CVM", "KernelVersion": "6.4", "ProtectType": "", "CloudTags": [ { "TagKey": "tag1", "TagValue": "tag2" } ], "IsAddedOnTheFifteen": 1, "IpList": "1.2.3.4", "VpcId": "vpc-intc", "MachineExtraInfo": { "WanIP": "49.233.15.7", "PrivateIP": "172.18.16.41", "NetworkType": 0, "NetworkName": "", "InstanceID": "ins-7m0suost", "HostName": "txy-app-pre-node1" }, "InstanceId": "vpc-intc", "Remark": "remark", "CloudFrom": 0, "Platform": "ali" } ] |
TotalCount | Integer | 主机数量 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取区域主机列表
本接口 (DescribeMachines) 用于获取区域主机列表。
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMachineList
<公共请求参数>
{
"MachineType": "CVM",
"MachineRegion": "ap-guangzhou"
}
输出示例
{
"Response": {
"Machines": [
{
"MachineName": "stone",
"MachineOs": "Windows",
"MachineStatus": "ONLINE",
"Uuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76",
"Quuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76",
"VulNum": 0,
"MachineIp": "172.16.20.1",
"IsProVersion": true,
"MachineWanIp": "1.2.2.3",
"PayMode": "PREPAY",
"MalwareNum": 0,
"Tag": [
{
"Rid": 0,
"Name": "tag1",
"TagId": 1
}
],
"BaselineNum": 0,
"CyberAttackNum": 0,
"SecurityStatus": "SAFE",
"InvasionNum": 0,
"RegionInfo": {
"RegionCode": "gz",
"Region": "ap-guangzhuo",
"RegionId": 1,
"RegionName": "广州",
"RegionNameEn": "chine guangzhou"
},
"InstanceState": "TERMINATED_PRO_VERSION",
"LicenseStatus": 1,
"ProjectId": 0,
"HasAssetScan": 1,
"MachineType": "CVM",
"KernelVersion": "6.4",
"ProtectType": "BASIC_VERSION",
"CloudTags": [
{
"TagKey": "tag1",
"TagValue": "tag2"
}
],
"IsAddedOnTheFifteen": 1,
"IpList": "1.2.3.4",
"VpcId": "vpc-intc",
"MachineExtraInfo": {
"WanIP": "49.233.15.7",
"PrivateIP": "172.18.16.41",
"NetworkType": 0,
"NetworkName": "vpc-9m7rhl6w",
"InstanceID": "ins-7m0suost",
"HostName": "txy-app-pre-node1"
},
"InstanceId": "vpc-intc",
"Remark": "remark"
}
],
"TotalCount": 1,
"RequestId": "fbd6ea2c-1894-47b0-bf3e-095c78138f76"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.APIServerFail | 调用API服务失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidFormat | 参数格式错误。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |