1. 接口描述
接口请求域名： csip.tencentcloudapi.com 。
获取cvm列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCVMAssets。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-21。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值：["mem-6wfo0fzks3","mem-85fo0fzks4"] |
| Filter | 否 | Filter | 过滤器参数 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：10 |
| Data | Array of CVMAssetVO | 机器列表 |
| RegionList | Array of FilterDataObject | 地域列表 |
| DefenseStatusList | Array of FilterDataObject | 防护状态 示例值：[ { "Text": "基础版未防护", "Value": "2" }, { "Text": "旗舰版防护中", "Value": "4" } ] |
| VpcList | Array of FilterDataObject | vpc枚举 |
| AssetTypeList | Array of FilterDataObject | 资产类型枚举 示例值：[ { "Text": "CVM", "Value": "CVM" } ] |
| SystemTypeList | Array of FilterDataObject | 操作系统枚举 示例值：[ { "Text": "linux", "Value": "linux" }, { "Text": "windows", "Value": "windows" } ] |
| IpTypeList | Array of FilterDataObject | ip列表 示例值：[ { "Text": "公网资产", "Value": "1" }, { "Text": "私网资产", "Value": "0" } ] |
| AppIdList | Array of FilterDataObject | appid列表 示例值：[ { "Text": "1302396215", "Value": "1302396215" } ] |
| ZoneList | Array of FilterDataObject | 可用区列表 |
| OsList | Array of FilterDataObject | os列表 |
| AssetMapInstanceTypeList | Array of AssetInstanceTypeMap | 资产类型和实例类型的对应关系 示例值：[ { "Text": "主机", "Value": "Instance", "InstanceTypeList": [ { "Text": "CVM", "Value": "CVM" } ] } ] |
| PublicPrivateAttr | Array of FilterDataObject | 公网内网枚举 示例值：[ { "Text": "内网服务", "Value": "0" }, { "Text": "公网服务", "Value": "1" } ] |
| ProtectStatusList | Array of FilterDataObject | 主机防护状态 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取cvm列表
获取cvm列表
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCVMAssets
<公共请求参数>
{
"Filter": {
"Filters": [
{
"Name": "ProtectStatus",
"Values": [
"4"
],
"OperatorType": 7
},
{
"Name": "TimeRange",
"Values": [
"2"
],
"OperatorType": 7
}
],
"Limit": 10,
"Offset": 0,
"Order": "desc",
"By": "AssetCreateTime"
},
"MemberId": [
"mem-5b28e2010c18f07a"
]
}输出示例
{
"Response": {
"AppIdList": [
{
"Text": "125000001",
"Value": "130200001"
}
],
"AssetMapInstanceTypeList": [
{
"Text": "主机",
"Value": "Instance",
"InstanceTypeList": [
{
"Text": "CVM",
"Value": "CVM"
}
]
}
],
"AssetTypeList": [
{
"Text": "CVM",
"Value": "CVM"
}
],
"Data": [
{
"AssetId": "ins-ggrnxdwj",
"AssetName": "主机测试2-win",
"PublicIp": "139.*.*.171",
"PrivateIp": "172.16.0.9",
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"IsCore": 2,
"AssetType": "CVM",
"Region": "ap-chengdu",
"AvailableArea": "成都一区",
"Os": "Windows Server 2012 R2 数据中心版 64位中文版",
"VpcId": "vpc-pr0wcl5e",
"VpcName": "fengqqian",
"OsName": "Windows Server 2012 R2 数据中心版 64位中文版",
"CPUInfo": "AMD EPYC 7K83 64-Core Processor",
"CPUSize": 2,
"CPULoad": "未知",
"MemorySize": "4GB",
"MemoryLoad": "34.21%",
"DiskSize": "49GB",
"DiskLoad": "29.13%",
"PartitionCount": 2,
"AppId": 1302396215,
"Uin": "100014592178",
"SubnetId": "subnet-hn32qgp5",
"SubnetName": "fengsub",
"InstanceUuid": "82727b6e-3676-4660-ac4e-c281dba1b23f",
"InstanceQUuid": "82727b6e-3676-4660-ac4e-c281dba1b23f",
"NickName": "nickname",
"AccountCount": "2",
"ProcessCount": "41",
"AppCount": "1",
"PortCount": 19,
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"PortRisk": 0,
"VulnerabilityRisk": 0,
"ConfigurationRisk": 52,
"LastScanTime": "2024-10-30 05:02:29",
"AssetCreateTime": "2024-10-28 19:36:43",
"BASAgentStatus": -1,
"CWPStatus": 4,
"ProtectStatus": 4,
"Attack": 0,
"Access": 0,
"Intercept": 0,
"NetWorkOut": 0,
"RiskExposure": 0,
"ScanTask": 1,
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"CVMStatus": 1,
"CVMAgentStatus": 1,
"DefenseModel": 1,
"TatStatus": 1,
"AgentStatus": 1,
"CloseDefenseCount": 0,
"CpuTrend": [
{
"Key": "2024-10-29 07:45:16",
"Value": "0.5208333"
},
{
"Key": "2024-10-29 23:43:52",
"Value": "0.26041666"
}
],
"MemoryTrend": [
{
"Key": "2024-10-29 07:45:16",
"Value": "24"
},
{
"Key": "2024-10-29 23:43:52",
"Value": "32"
}
],
"InstanceState": "RUNNING",
"SecurityGroupIds": [
"sg-ijs188uj"
],
"AgentCpuPer": 0,
"AgentMemRss": 26088,
"RealAppid": 0,
"CloudType": 0,
"OfflineTime": "2024-10-29 23:43:52"
},
{
"AssetId": "ins-m1xkxkv4",
"AssetName": "linux-arm-foo",
"PublicIp": "119.*.*.202",
"PrivateIp": "10.10.0.48",
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"IsCore": 2,
"AssetType": "CVM",
"Region": "ap-guangzhou",
"AvailableArea": "广州六区",
"Os": "Ubuntu 18.04(arm64)",
"VpcId": "vpc-fw2ndu5f",
"VpcName": "arm-vpc",
"OsName": "Ubuntu 18.04(arm64)",
"CPUInfo": "AMD EPYC 7K83 64-Core Processor",
"CPUSize": 2,
"CPULoad": "低",
"MemorySize": "4GB",
"MemoryLoad": "14.41%",
"DiskSize": "146GB",
"DiskLoad": "36.94%",
"PartitionCount": 5,
"AppId": 1302396215,
"Uin": "100014592178",
"SubnetId": "subnet-jol7wxbs",
"SubnetName": "fengsub",
"InstanceUuid": "e868e2da-8c44-4037-b4dd-daf790edf7a4",
"InstanceQUuid": "e868e2da-8c44-4037-b4dd-daf790edf7a4",
"NickName": "声声乌龙",
"AccountCount": "32",
"ProcessCount": "34",
"AppCount": "5",
"PortCount": 7,
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"PortRisk": 0,
"VulnerabilityRisk": 0,
"ConfigurationRisk": 1,
"LastScanTime": "2024-10-30 05:02:29",
"AssetCreateTime": "2024-09-26 11:28:19",
"BASAgentStatus": 0,
"CWPStatus": 4,
"ProtectStatus": 4,
"Attack": 0,
"Access": 0,
"Intercept": 0,
"NetWorkOut": 0,
"RiskExposure": 0,
"ScanTask": 14,
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"CVMStatus": 1,
"CVMAgentStatus": 1,
"DefenseModel": 1,
"TatStatus": 1,
"AgentStatus": 1,
"CloseDefenseCount": 0,
"CpuTrend": [
{
"Key": "2024-10-29 07:45:16",
"Value": "0.5208333"
},
{
"Key": "2024-10-29 23:43:52",
"Value": "0.26041666"
}
],
"MemoryTrend": [
{
"Key": "2024-10-29 07:45:16",
"Value": "24"
},
{
"Key": "2024-10-29 23:43:52",
"Value": "32"
}
],
"InstanceState": "RUNNING",
"SecurityGroupIds": [
"sg-biz3919h"
],
"AgentCpuPer": 0,
"AgentMemRss": 0,
"RealAppid": 0,
"CloudType": 0,
"OfflineTime": "2024-10-"
},
{
"AssetId": "ins-p7x4hn7p",
"AssetName": "自动化测试",
"PublicIp": "132.*.*.102",
"PrivateIp": "10.0.0.11",
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"IsCore": 2,
"AssetType": "CVM",
"Region": "ap-chengdu",
"AvailableArea": "成都一区",
"Os": "TencentOS Server 3.1 (TK4)",
"VpcId": "vpc-iozrpgxo",
"VpcName": "自动化测试",
"OsName": "TencentOS Server 3.1 (TK4)",
"CPUInfo": "Intel(R) Xeon(R) Platinum 8255C CPU @ 2.50GHz",
"CPUSize": 2,
"CPULoad": "低",
"MemorySize": "2GB",
"MemoryLoad": "22.72%",
"DiskSize": "49GB",
"DiskLoad": "18.62%",
"PartitionCount": 1,
"AppId": 1302396215,
"Uin": "100014592178",
"SubnetId": "subnet-5fect5mp",
"SubnetName": "fengsub1",
"InstanceUuid": "7a6eaa66-0f21-45c1-a33c-d89ca32d2866",
"InstanceQUuid": "7a6eaa66-0f21-45c1-a33c-d89ca32d2866",
"NickName": "声声乌龙",
"AccountCount": "32",
"ProcessCount": "30",
"AppCount": "5",
"PortCount": 4,
"InBandwidth": "0bps",
"OutBandwidth": "0bps",
"InFlow": "0B",
"OutFlow": "0B",
"PortRisk": 0,
"VulnerabilityRisk": 0,
"ConfigurationRisk": 7,
"LastScanTime": "2024-10-30 05:02:29",
"AssetCreateTime": "2024-09-09 20:34:02",
"BASAgentStatus": 1,
"CWPStatus": 4,
"ProtectStatus": 4,
"Attack": 0,
"Access": 0,
"Intercept": 0,
"NetWorkOut": 0,
"RiskExposure": 0,
"ScanTask": 24,
"MemberId": "mem-625c522c0913c901",
"IsNewAsset": 0,
"CVMStatus": 1,
"CVMAgentStatus": 1,
"DefenseModel": 1,
"TatStatus": 1,
"AgentStatus": 1,
"CloseDefenseCount": 0,
"CpuTrend": [
{
"Key": "2024-10-29 07:45:16",
"Value": "0.5208333"
},
{
"Key": "2024-10-29 23:43:52",
"Value": "0.26041666"
}
],
"MemoryTrend": [
{
"Key": "2024-10-29 07:45:16",
"Value": "24"
},
{
"Key": "2024-10-29 23:43:52",
"Value": "32"
}
],
"InstanceState": "RUNNING",
"SecurityGroupIds": [
"sg-ijs188uj"
],
"AgentCpuPer": 1.50754,
"AgentMemRss": 124244,
"RealAppid": 0,
"CloudType": 0,
"OfflineTime": "2024-10-03 11:29:11"
}
],
"DefenseStatusList": [
{
"Text": "基础版未防护",
"Value": "2"
},
{
"Text": "旗舰版防护中",
"Value": "4"
}
],
"IpTypeList": [
{
"Text": "公网资产",
"Value": "1"
},
{
"Text": "私网资产",
"Value": "0"
}
],
"OsList": [
{
"Text": "CentOS",
"Value": "1"
},
{
"Text": "Windows Server",
"Value": "6"
},
{
"Text": "TencentOS",
"Value": "7"
},
{
"Text": "Ubuntu",
"Value": "5"
},
{
"Text": "CoreOS",
"Value": "8"
},
{
"Text": "Debian",
"Value": "2"
}
],
"ProtectStatusList": [
{
"Text": "未安装",
"Value": "0"
},
{
"Text": "基础版防护中",
"Value": "1"
},
{
"Text": "普惠版防护中",
"Value": "2"
},
{
"Text": "专业版防护中",
"Value": "3"
},
{
"Text": "旗舰版防护中",
"Value": "4"
},
{
"Text": "已离线",
"Value": "5"
},
{
"Text": "已关机",
"Value": "6"
}
],
"PublicPrivateAttr": [
{
"Text": "内网服务",
"Value": "0"
},
{
"Text": "公网服务",
"Value": "1"
}
],
"RegionList": [
{
"Text": "上海",
"Value": "ap-shanghai"
},
{
"Text": "成都",
"Value": "ap-chengdu"
},
{
"Text": "硅谷",
"Value": "na-siliconvalley"
},
{
"Text": "北京",
"Value": "ap-beijing"
},
{
"Text": "广州",
"Value": "ap-guangzhou"
}
],
"RequestId": "4a537d7d-0562-4fe8-8f62-6028777279eb",
"SystemTypeList": [
{
"Text": "linux",
"Value": "linux"
},
{
"Text": "windows",
"Value": "windows"
}
],
"Total": 3,
"VpcList": [
{
"Text": "li-vr",
"Value": "vpc-gu5j0xuy"
},
{
"Text": "fengqqian",
"Value": "vpc-pr0wcl5e"
},
{
"Text": "Default-VPC",
"Value": "vpc-6bmvfm3h"
},
{
"Text": "li-跨账号2",
"Value": "vpc-1hezruby"
},
{
"Text": "fengqqian2",
"Value": "vpc-fw2ndu5f"
},
{
"Text": "fengqqian",
"Value": "vpc-294np9d5"
},
{
"Text": "自动化测试请勿删除",
"Value": "vpc-iozrpgxo"
},
{
"Text": "Default-VPC",
"Value": "vpc-ommo5hlv"
},
{
"Text": "vpc-gz-0",
"Value": "vpc-68t3zm89"
}
],
"ZoneList": [
{
"Text": "上海五区",
"Value": "ap-shanghai-5"
},
{
"Text": "成都一区",
"Value": "ap-chengdu-1"
},
{
"Text": "硅谷一区",
"Value": "na-siliconvalley-1"
},
{
"Text": "北京七区",
"Value": "ap-beijing-7"
},
{
"Text": "广州六区",
"Value": "ap-guangzhou-6"
},
{
"Text": "广州三区",
"Value": "ap-guangzhou-3"
}
]
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
