1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
主机详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCWPMachineDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| InstanceId | 否 | String | 实例ID 示例值:ins-4ty8h8gy |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-a01"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MachineDetail | MachineDetail | 主机详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCWPMachineDetail
<公共请求参数>
{
"InstanceId": "ins-4ty8h8gy",
"MemberId": [
"mem-a01"
]
}
输出示例
{
"Response": {
"MachineDetail": {
"AgentStatus": "ONLINE",
"AgentVersion": "5.3.4.16",
"AppId": 260199982,
"AssetTypeName": "CVM",
"BootTime": 1780303890,
"BuyTime": 1779676766,
"CloudFromEnum": "Tencent",
"CloudTags": [
{
"TagKey": "test_label",
"TagValue": "value2"
}
],
"CoreVersion": "3.10.0-1160.119.1.el7.x86_64",
"Cpu": "AMD EPYC 9K65 192-Core Processor",
"CpuLoad": "低",
"CpuSize": 2,
"DeviceVersion": "CVM",
"Disks": [
{
"Name": "/dev/vda1",
"Path": "/",
"Percent": 15.25454,
"Size": 50267,
"Type": "ext4",
"Used": 7668
}
],
"EndTime": 0,
"ExposedStatus": "UNEXPOSED",
"InstallTime": 1779245512,
"InstanceID": "ins-4ty8h8gy",
"InstanceStatus": "RUNNING",
"KernelVersion": "3.10.0-1160.119.1.el7.x86_64",
"LatestLiveTime": 1780506639,
"LatestOfflineTime": 1780490597,
"MachineIp": "172.16.16.4",
"MachineName": "change_centos_tat_no_agent",
"MachineOs": "CentOS 7.8 64位",
"MachineStatus": "RUNNING",
"MachineWanIp": "",
"MemSize": 1966,
"MemoryLoad": "30.87",
"NetCards": [
{
"DnsServer": "183.60.83.19,183.60.82.98",
"Gateway": "172.16.16.1",
"Ip": "172.16.16.4",
"Ipv6": "",
"Mac": "52:54:00:e1:d7:ac",
"Name": "eth0"
}
],
"OsByAgent": "CentOS Linux release 7.8.2003 (Core)",
"PayMode": "PREPAID",
"ProjectId": 0,
"ProtectDays": 19,
"ProtectType": "ULTIMATE",
"Quuid": "62740df1-aaaf-4787-a0aa-d3ddd72c635a",
"RegionInfo": {
"Region": "ap-guangzhou",
"RegionCode": "gz",
"RegionId": 1,
"RegionName": "华南地区(广州)",
"RegionNameEn": "South China (Guangzhou)"
},
"Remark": "测试一下备注",
"SerialNumber": "62740df1-aaaf-4787-a0aa-d3ddd72c635a",
"TagItems": [
{
"Color": "blue",
"Description": "测试自动打标策略打标签",
"ID": 132,
"TagKey": "委派管理员标签key1",
"TagValue": "value2"
}
],
"TagModifyInfo": {
"AppID": 260199982,
"AssetType": "cvm_instance",
"InstanceID": "ins-4ty8h8gy",
"Provider": "tencent"
},
"Uuid": "62740df1-aaaf-4787-a0aa-d3ddd72c635a",
"VpcCidrBlock": "172.16.0.0/16",
"VpcId": "vpc-8amv7xvn",
"VpcName": "Default-VPC"
},
"RequestId": "d9dd67d5-eccd-4f60-8d31-d7820ff3a07c"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。