Domain name for API request: csip.intl.tencentcloudapi.com.
Retrieve the cvm list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeCVMAssets. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| MemberId.N | No | Array of String | Group Account Member ID |
| Filter | No | Filter | Filter parameters. |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total number. |
| Data | Array of CVMAssetVO | Machine list |
| RegionList | Array of FilterDataObject | Region list |
| DefenseStatusList | Array of FilterDataObject | Protection status |
| VpcList | Array of FilterDataObject | VPC Enumeration |
| AssetTypeList | Array of FilterDataObject | Asset Type Enumeration |
| SystemTypeList | Array of FilterDataObject | Operating System Enumeration |
| IpTypeList | Array of FilterDataObject | IP List |
| AppIdList | Array of FilterDataObject | AppID List |
| ZoneList | Array of FilterDataObject | Availability Zone List |
| OsList | Array of FilterDataObject | OS List |
| AssetMapInstanceTypeList | Array of AssetInstanceTypeMap | Mapping of asset type and instance type. |
| PublicPrivateAttr | Array of FilterDataObject | Public network private network enumeration. |
| ProtectStatusList | Array of FilterDataObject | Host protection status. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Retrieve the cvm list
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCVMAssets
<Common request parameters>
{
"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": [
{
host
"Value": "Instance",
"InstanceTypeList": [
{
"Text": "CVM",
"Value": "CVM"
}
]
}
],
"AssetTypeList": [
{
"Text": "CVM",
"Value": "CVM"
}
],
"Data": [
{
"AssetId": "ins-ggrnxdwj",
"AssetName": "Host test 2-win",
"PublicIp": "139.*.*.171",
"PrivateIp": "172.16.0.9",
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"IsCore": 2,
"AssetType": "CVM",
"Region": "ap-chengdu",
"AvailableArea": "Chengdu Zone 1",
"Os": "Windows Server 2012 R2 Datacenter Edition 64-bit Chinese",
"VpcId": "vpc-pr0wcl5e",
"VpcName": "fengqqian",
"OsName": "Windows Server 2012 R2 Datacenter Edition 64-bit Chinese"
"CPUInfo": "AMD EPYC 7K83 64-Core Processor",
"CPUSize": 2,
"CPULoad": "unknown",
"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": "Guangzhou Zone 6"
"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": "Low",
"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": "Melon Oolong"
"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": "Automatic Test",
"PublicIp": "132.*.*.102",
"PrivateIp": "10.0.0.11",
"Tag": [
{
"Name": "name1",
"Value": "value1"
}
],
"IsCore": 2,
"AssetType": "CVM",
"Region": "ap-chengdu",
"AvailableArea": "Chengdu Zone 1",
"Os": "TencentOS Server 3.1 (TK4)",
"VpcId": "vpc-iozrpgxo",
"VpcName": "Automatic Test"
"OsName": "TencentOS Server 3.1 (TK4)",
"CPUInfo": "Intel(R) Xeon(R) Platinum 8255C CPU @ 2.50GHz",
"CPUSize": 2,
"CPULoad": "Low",
"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": "Melon Oolong"
"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": [
{
Basic version unprotected
"Value": "2"
},
{
Flagship protection
"Value": "4"
}
],
"IpTypeList": [
{
public network asset
"Value": "1"
},
{
private network asset
"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": "Not installed"
"Value": "0"
},
{
Basic edition protection
"Value": "1"
},
{
inclusive edition protection
"Value": "2"
},
{
Protection by Pro Edition
"Value": "3"
},
{
Flagship protection
"Value": "4"
},
{
"Text": "Offline"
"Value": "5"
},
{
"Text": "Shut down"
"Value": "6"
}
],
"PublicPrivateAttr": [
{
Private Network Service
"Value": "0"
},
{
public network service
"Value": "1"
}
],
"RegionList": [
{
Shanghai
"Value": "ap-shanghai"
},
{
Chengdu
"Value": "ap-chengdu"
},
{
Silicon Valley
"Value": "na-siliconvalley"
},
{
Beijing
"Value": "ap-beijing"
},
{
"Text": "Guangzhou"
"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"
},
{
li-across different accounts2
"Value": "vpc-1hezruby"
},
{
"Text": "fengqqian2",
"Value": "vpc-fw2ndu5f"
},
{
"Text": "fengqqian",
"Value": "vpc-294np9d5"
},
{
"Text": "Automatic test, do not delete"
"Value": "vpc-iozrpgxo"
},
{
"Text": "Default-VPC",
"Value": "vpc-ommo5hlv"
},
{
"Text": "vpc-gz-0",
"Value": "vpc-68t3zm89"
}
],
"ZoneList": [
{
Shanghai Zone 5
"Value": "ap-shanghai-5"
},
{
Chengdu Zone 1
"Value": "ap-chengdu-1"
},
{
"Text": "Silicon Valley Zone 1"
"Value": "na-siliconvalley-1"
},
{
Beijing Zone 7
"Value": "ap-beijing-7"
},
{
"Text": "Guangzhou Zone 6"
"Value": "ap-guangzhou-6"
},
{
Guangzhou Zone 3
"Value": "ap-guangzhou-3"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback