tencent cloud

APIs

DocumentaçãoAPIsCloud Security CenterHost Asset APIsDescribeCWPMachines

DescribeCWPMachines

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:09:42

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Host list

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeCWPMachines.
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

1. Primary table field filtering (requires specifying OperatorType)
MachineName: host name, supports OperatorType 9 (fuzzy), 7 (IN), Values example: ["test-server"]
MachineIp: private IP address, supports OperatorType 9 (fuzzy), 7 (IN), Values example: ["10.0.0.1"]
MachineWanIp: public network IP, supports OperatorType 9 (fuzzy), 7 (IN), Values example: ["1.2.3.4"]
InstanceID: instance ID, supports OperatorType 9 (fuzzy), 7 (IN), Values example: ["ins-xxxxx"]
MachineStatus / InstanceStatus: instance status, supports OperatorType 7 (IN), 1 (equal), Values example: ["RUNNING"], available Values: RUNNING/STOPPED/EXPIRED
MachineOs: operating system type, supports OperatorType 7 (IN), Values example: ["1"], the value is a numeric code, see OsType description below
VpcId: VPC ID, supports OperatorType 7 (IN), 1 (equal), Values example: ["VPC-xxxxx"]
CloudFromEnum: cloud service provider, supports OperatorType 7 (IN), 1 (equal), Values example: ["0"], the value is a numeric code, see CloudFrom description below
Region: Region, supports OperatorType 7 (IN), 1 (equal), Values example: ["ap-guangzhou"]
AppId: account AppId, supports OperatorType 7 (IN), 1 (equal), Values example: ["1234567890"]
ProjectId: project ID, supports OperatorType 7 (IN), 1 (equal), Values example: ["0"]

2. Pre-filter fields (no OperatorType required)
AgentStatus: Agent status, single selection, Values example: ["ONLINE"], available Values: ONLINE/OFFLINE/UNINSTALL
ProtectType: protection type (comprehensive), Values example: ["ULTIMATE"], available Values: BASIC/PRO/ULTIMATE/NONE
CsipProtectType: CSIP protection type, Values example: ["ULTIMATE"], available Values: BASIC/PRO/ULTIMATE/NONE
CloudTags: cloud tag, Values example: ["tagKey$tagValue"], format: tagKey$tagValue or tagKey (matches key only), up to 5 Values
Tags: asset tag, Values example: ["123"], the value is a tag ID
ExposedStatus: exposure status, single selection, Values example: ["EXPOSED"], available Values: NOT_APPLICABLE/EXPOSED/UNEXPOSED

3. Special filter fields (no OperatorType required)
NetworkType: network type, single selection, Values example: ["1"], 1=VPC network, 2=BASIC network, 3=Non-Tencent Cloud Network
MachineType: machine type, multiple selections allowed, Values example: ["CVM"], available Values: CVM/BM/ECM/LH/EKS-NATIVE/ECS/EC2/VMS
Common: general search, single selection, Values example: ["keyword"], performs fuzzy matching on private IP address, public network IP, host name, and instance ID at the same time
NeedTatStatus No Boolean

Whether TAT status information is required
MoreInformation No Boolean

Whether additional information is required, such as security center tags and Tencent Cloud tags
NeedContainerInfo No Boolean

Whether container information is required, such as number of containers, cores, and container protection status

3. Output Parameters

Parameter Name Type Description
Machines Array of Machine

Host list
Total Integer

Total.
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.

4. Example

Example1 1

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCWPMachines
<Common request parameters>

{
    "MemberId": [
        "mem-a1f"
    ],
    "Filter": {
        "Limit": 100
    },
    "NeedTatStatus": true,
    "MoreInformation": true,
    "NeedContainerInfo": true
}

Output Example

{
    "Response": {
        "Machines": [
            {
                "AgentStatus": "ONLINE",
                "AgentVersion": "5.4.4.133",
                "AppId": 260083796,
                "CloudFromEnum": "Tencent",
                "ContainerCount": 0,
                "ContainerDefendStatus": "Unknown",
                "CpuCoreCount": 2,
                "CsipProtectType": "BASIC",
                "ExposedStatus": "NONE",
                "InstanceID": "ins-*****nsn",
                "InstanceStatus": "RUNNING",
                "IpList": [
                    "fe80:************acc:c330"
                ],
                "IsNew": true,
                "KernelVersion": "6.6.117-45.7.3.tl4.x86_64",
                "LatestOfflineTime": 1781545140,
                "MachineIp": "10.216.0.85",
                "MachineName": "VM-0-85-tencentos",
                "MachineOs": "TencentOS Server 4",
                "MachineWanIp": "10*.******.*11",
                "NodeType": "NONE",
                "PayMode": "PREPAID",
                "ProjectId": 0,
                "ProtectType": "ULTIMATE",
                "Quuid": "969faa98-**************-55cf8ed1eccf",
                "RegionInfo": {
                    "Region": "ap-others",
                    "RegionCode": "others",
                    "RegionId": 47,
                    "RegionName": "Other regions (other)",
                    "RegionNameEn": "Others (Other)"
                },
                "Remark": "",
                "TagModifyInfo": {
                    "AppID": 260083796,
                    "AssetType": "server_host",
                    "InstanceID": "ins-*****nsn",
                    "Provider": "tencent"
                },
                "TatStatus": "",
                "Uuid": "969faa98-***************55cf8ed1eccf",
                "VpcId": "vpc-j*****ox"
            }
        ],
        "Total": 18,
        "RequestId": "44f9ea21-c601-4974-b550-5bb988de4168"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Anterior: DescribeCWPMachineDetailPróximo: ModifyMachineRemark

Ajuda e Suporte

Esta página foi útil?

comentários