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 | - 注意:此字段可能返回 null,表示取不到有效值。 |
Data | Array of CVMAssetVO | - 注意:此字段可能返回 null,表示取不到有效值。 |
RegionList | Array of FilterDataObject | 地域列表 注意:此字段可能返回 null,表示取不到有效值。 |
DefenseStatusList | Array of FilterDataObject | 防护状态 注意:此字段可能返回 null,表示取不到有效值。 |
VpcList | Array of FilterDataObject | vpc枚举 注意:此字段可能返回 null,表示取不到有效值。 |
AssetTypeList | Array of FilterDataObject | 资产类型枚举 注意:此字段可能返回 null,表示取不到有效值。 |
SystemTypeList | Array of FilterDataObject | 操作系统枚举 注意:此字段可能返回 null,表示取不到有效值。 |
IpTypeList | Array of FilterDataObject | ip列表 注意:此字段可能返回 null,表示取不到有效值。 |
AppIdList | Array of FilterDataObject | appid列表 注意:此字段可能返回 null,表示取不到有效值。 |
ZoneList | Array of FilterDataObject | 可用区列表 注意:此字段可能返回 null,表示取不到有效值。 |
OsList | Array of FilterDataObject | os列表 注意:此字段可能返回 null,表示取不到有效值。 |
AssetMapInstanceTypeList | Array of AssetInstanceTypeMap | 资产类型和实例类型的对应关系 注意:此字段可能返回 null,表示取不到有效值。 |
PublicPrivateAttr | Array of FilterDataObject | 公网内网枚举 注意:此字段可能返回 null,表示取不到有效值。 |
ProtectStatusList | Array of FilterDataObject | 主机防护状态 注意:此字段可能返回 null,表示取不到有效值。 |
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
<公共请求参数>
{
"MemberId": [
"abc"
],
"Filter": {
"Limit": 0,
"Offset": 0,
"Order": "abc",
"By": "abc",
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
],
"OperatorType": 0
}
],
"StartTime": "abc",
"EndTime": "abc"
}
}
输出示例
{
"Response": {
"AppIdList": [
{
"Text": "1300448058",
"Value": "1300448058"
}
],
"AssetTypeList": [
{
"Text": "边缘计算机器(ECM)",
"Value": "ECM"
},
{
"Text": "腾讯云服务器(CVM)",
"Value": "CVM"
}
],
"Data": [
{
"Access": 0,
"AccountCount": "-",
"AppCount": "-",
"AppId": 1300448058,
"AssetCreateTime": "2023-02-16 16:51:34",
"AssetId": "ein-b41zgmgq",
"AssetName": "test1",
"AssetType": "ECM",
"Attack": 0,
"AvailableArea": "",
"CPUInfo": "",
"CPULoad": "低",
"CPUSize": 0,
"CWPStatus": 1,
"ConfigurationRisk": 0,
"DiskLoad": "0.00%",
"DiskSize": "0GB",
"InBandwidth": "0.00bps",
"InFlow": "0.00B",
"InstanceQUuid": "40b8a793-1e96-4101-b832-1f973b8efdb7",
"InstanceUuid": "",
"Intercept": 0,
"IsCore": 1,
"LastScanTime": "2023-03-31 17:40:20",
"MemberId": "mem-c957e6a7195c85e0",
"MemoryLoad": "0.00%",
"MemorySize": "0GB",
"NetWorkOut": 0,
"NickName": "天空之蓝",
"Os": "CentOS 8.0 64bit",
"OsName": "CentOS 8.0 64bit",
"OutBandwidth": "0.00bps",
"OutFlow": "0.00B",
"PartitionCount": 0,
"PortCount": 0,
"PortRisk": 0,
"PrivateIp": "10.212.0.4",
"ProcessCount": "-",
"PublicIp": "119.147.20.109",
"Region": "ap-guangzhou",
"ScanTask": 13,
"SubnetId": "subnet-0aos839s",
"SubnetName": "",
"Tag": [
{
"Name": "测试A",
"Value": "测试B"
}
],
"RiskExposure": 0,
"BASAgentStatus": 0,
"Uin": "100011616646",
"VpcId": "vpc-4c9w05r5",
"VpcName": "",
"VulnerabilityRisk": 0
}
],
"DefenseStatusList": [
{
"Text": "未开通防护",
"Value": "1"
},
{
"Text": "基础版未防护",
"Value": "2"
}
],
"IpTypeList": [
{
"Text": "公网资产",
"Value": "1"
},
{
"Text": "私网资产",
"Value": "0"
}
],
"OsList": [
{
"Text": "CentOS",
"Value": "1"
},
{
"Text": "未知",
"Value": "0"
},
{
"Text": "TencentOS",
"Value": "7"
},
{
"Text": "Ubuntu",
"Value": "5"
}
],
"RegionList": [
{
"Text": "广州",
"Value": "ap-guangzhou"
},
{
"Text": "上海",
"Value": "ap-shanghai"
},
{
"Text": "北京",
"Value": "ap-beijing"
},
{
"Text": "成都",
"Value": "ap-chengdu"
},
{
"Text": "南京",
"Value": "ap-nanjing"
}
],
"RequestId": "71673908-8c7d-41c3-8564-57c741ed3596",
"SystemTypeList": [
{
"Text": "linux",
"Value": "linux"
}
],
"Total": 29,
"VpcList": [
{
"Text": "跨租户天空之蓝",
"Value": "vpc-f6xj8nho"
},
{
"Text": "成都sdwan",
"Value": "vpc-ebfqtnxa"
},
{
"Text": "冲突sdwan",
"Value": "vpc-dw314am3"
},
{
"Text": "vpctest",
"Value": "vpc-rkm452h0"
},
{
"Text": "Default-VPC很长的很长的231321321321321313",
"Value": "vpc-5vcbd7cv"
}
],
"ZoneList": [
{
"Text": "广州",
"Value": "ap-guangzhou"
},
{
"Text": "上海",
"Value": "ap-shanghai"
},
{
"Text": "北京",
"Value": "ap-beijing"
},
{
"Text": "成都",
"Value": "ap-chengdu"
},
{
"Text": "南京",
"Value": "ap-nanjing"
}
]
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。