1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
查询批量导入机器信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeImportMachineInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
MachineList.N | 是 | Array of String | 服务器内网IP(默认)/ 服务器名称 / 服务器ID 数组 (最大 1000条) 示例值:["10.244.64****"] |
ImportType | 是 | String | 批量导入的数据类型:Ip、Name、Id 三选一 示例值:ip |
IsQueryProMachine | 否 | Boolean | 该参数已作废. 示例值:true |
Filters.N | 否 | Array of Filters | 过滤条件: 示例值:[{"Name": "Version", "Values": ["UnFlag****"]}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EffectiveMachineInfoList | Array of EffectiveMachineInfo | 有效的机器信息列表:机器名称、机器公网/内网ip、机器标签 示例值:[{"MachineName": "KISYUN-TXGZ-BZRDP.G01-64", "MachinePublicIp": "10.0.1", "MachinePrivateIp": "10.244.64", "MachineTag": null, "CloudTags": [{"TagKey": "Use", "TagValue": "Produc"}], "Quuid": "cb28d31e-b727-424d-bd9c-b8cff56a", "Uuid": "cb28d31e-b727-424d-bd9c-b8cff56a", "KernelVersion": "1.0.1", "MachineStatus": "OFFLINE", "LicenseOrder": {"LicenseId": 0, "LicenseType": 0, "SourceType": 0, "ResourceId": "", "Status": 0}, "VulNum": 0, "InstanceID": "ins-pgja****", "CloudFrom": 0}] |
InvalidMachineList | Array of String | 用户批量导入失败的机器列表(例如机器不存在等...) 示例值:[""a9fe0359-04d9-417f-ab6d-****""] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询批量导入机器信息
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImportMachineInfo
<公共请求参数>
{
"MachineList": [
"0.0.0.0"
],
"ImportType": "Ip",
"IsQueryProMachine": true
}
输出示例
{
"Response": {
"EffectiveMachineInfoList": [
{
"MachineName": "tke-np-ol06goby-worker",
"MachinePublicIp": "10.0.1.92",
"MachinePrivateIp": "172.17.2.23",
"MachineTag": [
{
"Rid": 10,
"Name": "dev",
"TagId": 10021
}
],
"CloudTags": [
{
"TagKey": "cwp",
"TagValue": "dev"
}
],
"Quuid": "a9fe0359-04d9-417f-ab6d-4941891d6c4b",
"Uuid": "a9fe0359-04d9-417f-ab6d-4941891d6c4b",
"KernelVersion": "5.4.241-19-0017.1_plus",
"MachineStatus": "OFFLINE",
"LicenseOrder": {
"LicenseId": 136621,
"LicenseType": 2,
"SourceType": 1,
"ResourceId": "white_883011a2fb7a2ce8f032025ec0437f52",
"Status": 1
},
"VulNum": 0,
"InstanceID": "eks-h847trlg"
}
],
"InvalidMachineList": [
"a9fe0359-04d9-417f-ab6d-****"
],
"RequestId": "633204c8-383a-4dbb-940b-2e92d0674529"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |