History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
AK brief information.
Used by actions: DescribeAccessKeyRisk, DescribeAccessKeyRiskDetail, DescribeSourceIPAsset.
| Name | Type | Description |
|---|---|---|
| ID | Integer | ak id. |
| Name | String | ak specific value. returns temporary key when temporary key is used. |
| User | String | Associated account. |
| Remark | String | Remarks |
Access key Alarm record.
Used by actions: DescribeAccessKeyAlarm, DescribeAccessKeyAlarmDetail.
| Name | Type | Description |
|---|---|---|
| Name | String | Alarm name. |
| Level | Integer | Alarm level. 0 - unavailable 1 - Note 2 - low risk 3 - medium risk 4 - high risk 5 - critical. |
| ID | Integer | Alarm record ID. |
| AlarmRuleID | Integer | Alarm rule ID. |
| AlarmType | Integer | Alarm type Abnormal call. Leak monitoring. |
| AccessKey | String | Access key. |
| AccessKeyID | Integer | Access key ID. |
| AccessKeyRemark | String | Access key remark. |
| LastAlarmTime | String | Last Alarm Time |
| Status | Integer | Alarm status. 0 - unprocessed 1 - processed 2 - ignored. |
| Date | String | Aggregate date. |
| Tag | Array of String | Alarm Tag. |
| Uin | String | Account associate Uin belonging to main account. |
| Nickname | String | Nickname of the main account. |
| SubUin | String | Sub-Account Uin belonging to. |
| SubNickname | String | Sub-Account nickname. |
| Type | Integer | Account type. 0 root account AK 1 sub-account AK 2 temporary key. |
| AppID | Integer | App ID |
| LeakEvidence | Array of String | Leakage evidence. |
| IsSupportEditWhiteAccount | Boolean | Whether editing a trusted account is supported. |
| Evidence | String | Alarm evidence. |
| RuleKey | String | Alarm rule flag. |
| CloudType | Integer | Cloud vendor type 0: tencent cloud 1: amazon web services 2: microsoft azure 3: google cloud 4: alibaba cloud 5: huawei cloud. |
| AIStatus | Integer | Alarm AI analysis status. -Analysis failed. 0 not analyzed. Under analysis. 2 analysis successful, real Alarm. 3 analysis successful, suspicious Alarm. |
| FirstAlarmTimestamp | Integer | First Alarm timestamp (in seconds). |
| LastAlarmTimestamp | Integer | Last Alarm timestamp (in seconds). |
Alarm count for access key.
Used by actions: DescribeAccessKeyRiskDetail.
| Name | Type | Description |
|---|---|---|
| ID | Integer | Access key ID. |
| AccessKey | String | Access key. |
| AlarmCount | Integer | Alarm count. |
| AccessKeyStatus | Integer | Security credentials status. valid values: 0 (disabled), 1 (enabled), 2 (deleted). |
| AccessKeyCreateTime | String | AK creation time. |
| LastAccessTime | String | AK last usage time. returns "-" if never used. |
Access key asset Alarm information.
Used by actions: DescribeAccessKeyAsset, DescribeAccessKeyUserDetail, DescribeAccessKeyUserList, DescribeSourceIPAsset.
| Name | Type | Description |
|---|---|---|
| Type | Integer | Alarm type/risktype. Alarm type:. Abnormal calls. Leakage detection. 2 custom. Risk type:. Configuration risk. Custom risk. |
| Count | Integer | Alarm count/number of risks. |
Access key asset information.
Used by actions: DescribeAccessKeyAsset.
| Name | Type | Description |
|---|---|---|
| ID | Integer | AK id. |
| Name | String | AK name. |
| Remark | String | Remarks |
| AppID | Integer | Account associate APPID. |
| Uin | String | Account associate Uin belonging to main account. |
| Nickname | String | Nickname of the main account. |
| SubUin | String | Sub-Account Uin belonging to. |
| SubNickname | String | Sub-Account nickname. |
| Type | Integer | Root account AK. Sub-Account AK. 2 temporary key. |
| Advice | Integer | Security advice enumeration. Normal. Process now. 2 recommend reinforcement. |
| AccessKeyAlarmList | Array of AccessKeyAlarmInfo | Alarm information list. |
| AccessKeyRiskList | Array of AccessKeyAlarmInfo | Risk information list. |
| IPCount | Integer | Source IP quantity. |
| CreateTime | String | Creation time. |
| LastAccessTime | String | Last access Time |
| Status | Integer | AK status. 0: disabled. 1: enabled. 2: deleted (deleted in cam, the security center still retains the previous log). |
| CheckStatus | Integer | 0 means detected. 1 indicates detecting. |
| CloudType | Integer | Cloud vendor type 0: tencent cloud 1: amazon web services 2: microsoft azure 3: google cloud 4: alibaba cloud 5: huawei cloud. |
Access key risk record.
Used by actions: DescribeAccessKeyRisk, DescribeAccessKeyRiskDetail.
| Name | Type | Description |
|---|---|---|
| Name | String | Risk name. |
| Level | Integer | Risk level. 0 - unavailable 1 - Note 2 - low risk 3 - medium risk 4 - high risk 5 - critical. |
| ID | Integer | Risk record ID. |
| RiskRuleID | Integer | Risk rule ID. |
| RiskType | Integer | Risk type. Configuration risk. |
| AccessKey | String | Access key. |
| AccessKeyID | Integer | Access key ID. |
| AccessKeyRemark | String | Access key remark. |
| RiskTime | String | Detection time of risk. |
| Status | Integer | Risk status. 0 - unprocessed 2 - ignored 3 - converged. |
| Tag | Array of String | Risk Tag. |
| Evidence | String | Risk evidence. |
| Description | String | Risk description. |
| Uin | String | Account associate Uin belonging to main account. |
| Nickname | String | Nickname of the main account. |
| SubUin | String | Sub-Account Uin belonging to. |
| SubNickname | String | Sub-Account nickname. |
| Type | Integer | Account type. 0 root account AK 1 sub-account AK. 2 temporary key. |
| CheckStatus | Integer | Detection status. 0: detected. 1 indicates detecting. |
| AppID | Integer | App ID |
| QueryParam | String | Query parameter corresponding to the risk. |
| CloudType | Integer | Cloud type 0 for tencent cloud 4 for alibaba cloud. |
| RelatedAK | Array of AKInfo | Related AK list, including AK name and remark. |
Access key account information.
Used by actions: DescribeAccessKeyUserDetail, DescribeAccessKeyUserList.
| Name | Type | Description |
|---|---|---|
| ID | Integer | Account ID. |
| Name | String | Account name |
| Type | Integer | 0 root account 1 sub-account. |
| AccessType | Integer | Access method. 0 API 1 console and API. |
| Advice | Integer | Security recommendation enumerate 0 normal 1 process immediately 2 recommend reinforcement. |
| AccessKeyAlarmList | Array of AccessKeyAlarmInfo | Alarm information list. |
| AccessKeyRiskList | Array of AccessKeyAlarmInfo | Risk information list. |
| AppID | Integer | Account associate APPID. |
| Nickname | String | Nickname of the main account. |
| SubNickname | String | Sub-Account nickname. |
| Uin | String | Account Uin belonging to main account. |
| SubUin | String | Account self uin, same as root account uin when it is the root account. |
| LoginIP | String | Login IP. |
| LoginLocation | String | Login address. |
| LoginTime | String | Log-In time. |
| ISP | String | ISP name |
| ActionFlag | Integer | Whether operation protection is enabled. 0 not enabled. 1: enabled. |
| LoginFlag | Integer | Is login protection enabled?. 0 not enabled. 1: enabled. |
| CheckStatus | Integer | 0 means detected. 1 means detecting. |
| CloudType | Integer | Cloud vendor type 0: tencent cloud 1: amazon web services 2: microsoft azure 3: google cloud 4: alibaba cloud 5: huawei cloud. |
Details of server assets
Used by actions: DescribeCVMAssetInfo.
| Name | Type | Description |
|---|---|---|
| VpcId | String | vpc-id |
| VpcName | String | vpc-name Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetName | String | Asset name Note: This field may return·null, indicating that no valid values can be obtained. |
| Os | String | Operating system Note: This field may return·null, indicating that no valid values can be obtained. |
| PublicIp | String | Public IP Note: This field may return·null, indicating that no valid values can be obtained. |
| PrivateIp | String | Private IP Note: This field may return·null, indicating that no valid values can be obtained. |
| Region | String | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetType | String | Asset type Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetId | String | Asset ID Note: This field may return·null, indicating that no valid values can be obtained. |
| AccountNum | Integer | Total number of accounts Note: This field may return·null, indicating that no valid values can be obtained. |
| PortNum | Integer | Number of ports Note: This field may return·null, indicating that no valid values can be obtained. |
| ProcessNum | Integer | Number of processes Note: This field may return·null, indicating that no valid values can be obtained. |
| SoftApplicationNum | Integer | Numbernumb of software applications Note: This field may return·null, indicating that no valid values can be obtained. |
| DatabaseNum | Integer | Number of databases Note: This field may return·null, indicating that no valid values can be obtained. |
| WebApplicationNum | Integer | Number of web applications Note: This field may return·null, indicating that no valid values can be obtained. |
| ServiceNum | Integer | Number of services Note: This field may return·null, indicating that no valid values can be obtained. |
| WebFrameworkNum | Integer | Number of web frameworks Note: This field may return·null, indicating that no valid values can be obtained. |
| WebSiteNum | Integer | Number of websites Note: This field may return·null, indicating that no valid values can be obtained. |
| JarPackageNum | Integer | Number of JAR packages Note: This field may return·null, indicating that no valid values can be obtained. |
| StartServiceNum | Integer | Number of enabled services Note: This field may return·null, indicating that no valid values can be obtained. |
| ScheduledTaskNum | Integer | Number of scheduled tasks Note: This field may return·null, indicating that no valid values can be obtained. |
| EnvironmentVariableNum | Integer | Number of environment variables Note: This field may return·null, indicating that no valid values can be obtained. |
| KernelModuleNum | Integer | Number of kernel modules Note: This field may return·null, indicating that no valid values can be obtained. |
| SystemInstallationPackageNum | Integer | Number of system installation packages Note: This field may return·null, indicating that no valid values can be obtained. |
| SurplusProtectDay | Integer | Remaining service validity in days Note: This field may return·null, indicating that no valid values can be obtained. |
| CWPStatus | Integer | Whether the CWPP agent is installed. Values: 1 (installed) and 0 (not installed)Note: This field may return·null, indicating that no valid values can be obtained. |
| Tag | Array of Tag | Tags Note: This field may return·null, indicating that no valid values can be obtained. |
| ProtectLevel | String | Protection level Note: This field may return·null, indicating that no valid values can be obtained. |
| ProtectedDay | Integer | Usage of CWPP service in days Note: This field may return·null, indicating that no valid values can be obtained. |
This example shows you how to obtain the cluster list.
Cluster protection status. enumerate on the left. display on the right.
Cluster protection status.
Not connected.
Unprotected.
2: partial protection.
3: under protection.
4: access exception.
5: accessing.
6: uninstalling.
7: uninstallation exception.
Used by actions: DescribeClusterAssets.
| Name | Type | Description |
|---|---|---|
| AppId | Integer | Tenant ID |
| Uin | String | Tenant uin. |
| Nick | String | Tenant Nickname |
| Region | String | Region. |
| AssetId | String | Cluster ID. |
| AssetName | String | Cluster name. |
| AssetType | String | Cluster type. |
| InstanceCreateTime | String | Cluster Creation Time |
| Status | String | Status. |
| ProtectStatus | Integer | Cluster protection status, enumerate on the left, display on the right. Protection status of the cluster. 0: not connected. Unprotected. 2: partial protection. 3: under protection. 4: access exception. 5: accessing. Uninstalling. 7: uninstallation exception. |
| ProtectInfo | String | Access information, being empty indicates no access exception info. |
| VpcId | String | VPC id. |
| VpcName | String | VPC name. |
| KubernetesVersion | String | kubernetes version. |
| Component | String | Runtime component. |
| ComponentVersion | String | Runtime component version. |
| ComponentStatus | String | Component status. |
| CheckTime | String | Health Checkup Time |
| MachineCount | Integer | Associated hosts. |
| PodCount | Integer | Associated Pod Count |
| ServiceCount | Integer | Associated Service Count |
| VulRisk | Integer | Vulnerability risk. |
| CFGRisk | Integer | Configuration risk. |
| CheckCount | Integer | Health Checkup Count |
| IsCore | Integer | Whether it is core. 1: Core; 2: Non-core. |
| IsNewAsset | Integer | New Asset or Not. 1: New |
| CloudType | Integer | Cloud asset type: 0: tencent cloud, 1: aws, 2: azure. |
This example shows you how to list the list of cluster pods.
Used by actions: DescribeClusterPodAssets.
| Name | Type | Description |
|---|---|---|
| AppId | Integer | Tenant ID |
| Uin | String | Tenant UIN |
| Nick | String | Tenant name |
| Region | String | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetId | String | Pod ID |
| AssetName | String | Pod name |
| InstanceCreateTime | String | Creation time of the pod Note: This field may return·null, indicating that no valid values can be obtained. |
| Namespace | String | Namespace Note: This field may return·null, indicating that no valid values can be obtained. |
| Status | String | Status Note: This field may return·null, indicating that no valid values can be obtained. |
| ClusterId | String | Cluster ID Note: This field may return·null, indicating that no valid values can be obtained. |
| ClusterName | String | Cluster name Note: This field may return·null, indicating that no valid values can be obtained. |
| MachineId | String | Server ID Note: This field may return·null, indicating that no valid values can be obtained. |
| MachineName | String | Server name Note: This field may return·null, indicating that no valid values can be obtained. |
| PodIp | String | Pod IP Note: This field may return·null, indicating that no valid values can be obtained. |
| ServiceCount | Integer | Number of associated services Note: This field may return·null, indicating that no valid values can be obtained. |
| ContainerCount | Integer | Number of associated containers Note: This field may return·null, indicating that no valid values can be obtained. |
| PublicIp | String | Public IP Note: This field may return·null, indicating that no valid values can be obtained. |
| PrivateIp | String | Private IP Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCore | Integer | Whether it's a critical asset. Values: 1 (critical asset), 0 (non-critical asset)Note: This field may return·null, indicating that no valid values can be obtained. |
| IsNewAsset | Integer | Whether it's a newly-added asset. Values: 1 (Yes), 0 (No)Note: This field may return·null, indicating that no valid values can be obtained. |
Details of asset scan result
Used by actions: DescribeSearchBugInfo.
| Name | Type | Description |
|---|---|---|
| AppID | String | AppID of the user Note: This field may return·null, indicating that no valid values can be obtained. |
| CVEId | String | CVE number Note: This field may return·null, indicating that no valid values can be obtained. |
| IsScan | Integer | Whether the asset is scanned. Values: 0: (default) Not scanned; 1: Scanning; 2: Scan completed; 3: Error while scanningNote: This field may return·null, indicating that no valid values can be obtained. |
| InfluenceAsset | Integer | Number of affected assets Note: This field may return·null, indicating that no valid values can be obtained. |
| NotRepairAsset | Integer | Number of not fixed assets Note: This field may return·null, indicating that no valid values can be obtained. |
| NotProtectAsset | Integer | Number of not protected assets Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskId | String | Task ID Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskPercent | Integer | Task progress in terms of percentage Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskTime | Integer | Task creation time Note: This field may return·null, indicating that no valid values can be obtained. |
| ScanTime | String | Scan start time Note: This field may return·null, indicating that no valid values can be obtained. |
Host process content.
Used by actions: DescribeAssetProcessList.
| Name | Type | Description |
|---|---|---|
| CloudAccountID | String | Cloud account ID. |
| InstanceName | String | Instance name |
| AppID | Integer | Tenant ID. |
| CloudAccountName | String | Account name. |
| InstanceID | String | Instance ID. |
| PublicIp | String | Public IP address |
| PrivateIp | String | Private IP address |
| ProcessID | String | Process ID |
| ProcessName | String | Process name |
| CmdLine | String | Command line |
| Port | String | Listening port list. |
Asset tags
Used by actions: CreateDomainAndIp, CreateRiskCenterScanTask, DeleteDomainAndIp, DescribeDomainAssets, DescribePublicIpAssets, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeVulViewVulRiskList.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | Tag Key, can be letters, digits, and underscores. |
| TagValue | String | No | Tag Value, can be letters, digits, and underscores. |
Details of a configuration risk
Used by actions: DescribeRiskCenterAssetViewCFGRiskList.
| Name | Type | Description |
|---|---|---|
| Id | String | The unique ID. |
| CFGName | String | Configuration name |
| CheckType | String | Check type |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| InstanceType | String | Instance type |
| AffectAsset | String | Affected assets |
| Level | String | Risk level |
| FirstTime | String | First detected |
| RecentTime | String | Last detected |
| From | String | Source of the task |
| Status | Integer | Status |
| CFGSTD | String | u200c- |
| CFGDescribe | String | Configuration details. |
| CFGFix | String | Fix suggestion |
| CFGHelpURL | String | URL of the help documentation |
| Index | String | Data entry key |
| AppId | String | User AppId |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User UIN Note: This field may return·null, indicating that no valid values can be obtained. |
Port risk details
Used by actions: DescribeRiskCenterAssetViewPortRiskList.
| Name | Type | Description |
|---|---|---|
| Port | Integer | Port |
| AffectAsset | String | Affected assets |
| Level | String | Risk level |
| InstanceType | String | Asset type |
| Protocol | String | Network protocol |
| Component | String | Components |
| Service | String | Service |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| Suggestion | Integer | Suggested action. 0: Keep as it is; 1: Block access requests; 2: Block the port |
| Status | Integer | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Unique ID of the asset |
| Index | String | Frontend index |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| AppId | String | User appid |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| From | String | Source of the task |
Details of a vulnerability
Used by actions: DescribeRiskCenterAssetViewVULRiskList.
| Name | Type | Description |
|---|---|---|
| AffectAsset | String | Affected assets |
| Level | String | Risk level: low - low risk, high - high risk, middle - medium risk, info - note, extreme - critical. |
| InstanceType | String | Asset type |
| Component | String | Components |
| Service | String | Service |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| Status | Integer | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Risk ID |
| Index | String | Frontend index |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| AppId | String | User appid |
| Nick | String | User Nickname |
| Uin | String | User UIN |
| VULType | String | Vulnerability type |
| Port | String | Port |
| Describe | String | Vulnerability description |
| AppName | String | Vulnerability impact component. |
| References | String | Technology reference. |
| AppVersion | String | Vulnerability impact version. |
| VULURL | String | Risks. |
| VULName | String | Vulnerability name |
| CVE | String | CVE number |
| Fix | String | Fixing solution |
| POCId | String | POC ID |
| From | String | Scan Source |
| CWPVersion | Integer | CWPP edition |
| IsSupportRepair | Boolean | Whether it can be fixed |
| IsSupportDetect | Boolean | Whether it can be detected |
| InstanceUUID | String | Instance UUID |
| Payload | String | Payload |
| EMGCVulType | Integer | Emergency Vulnerability Type. 1-Emergency Vulnerability; 0-Non-emergency Vulnerability. |
Details of a weak password risk
Used by actions: DescribeRiskCenterAssetViewWeakPasswordRiskList.
| Name | Type | Description |
|---|---|---|
| AffectAsset | String | Affected assets |
| Level | String | Risk level |
| InstanceType | String | Asset type |
| Component | String | Components |
| Service | String | Service |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| Status | Integer | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Unique ID of the asset |
| Index | String | Frontend index |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| AppId | String | User AppId |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| PasswordType | String | Weak password type |
| From | String | Source of the task |
| VULType | String | Vulnerability type |
| VULURL | String | Vulnerability URL |
| Fix | String | Fix suggestion |
| Payload | String | Pay load |
Vulnerability details
Used by actions: DescribeSearchBugInfo.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Vulnerability ID Note: This field may return null, indicating that no valid values can be obtained. |
| PatchId | String | POC ID of the vulnerability Note: This field may return null, indicating that no valid values can be obtained. |
| VULName | String | Vulnerability name Note: This field may return null, indicating that no valid values can be obtained. |
| Level | String | Vulnerability severity: high, middle, low, infoNote: This field may return null, indicating that no valid values can be obtained. |
| CVSSScore | String | CVSS score Note: This field may return null, indicating that no valid values can be obtained. |
| CVEId | String | CVE number Note: This field may return null, indicating that no valid values can be obtained. |
| Tag | String | Vulnerability tag Note: This field may return null, indicating that no valid values can be obtained. |
| VULCategory | Integer | Vulnerability category: 1: Web application vulnerabilities, 2: System component vulnerabilities, 3: Configuration risksNote: This field may return null, indicating that no valid values can be obtained. |
| ImpactOs | String | Operating systems affected by the vulnerability Note: This field may return null, indicating that no valid values can be obtained. |
| ImpactCOMPENT | String | Components affected by the vulnerability Note: This field may return null, indicating that no valid values can be obtained. |
| ImpactVersion | String | Versions affected by the vulnerability Note: This field may return null, indicating that no valid values can be obtained. |
| Reference | String | Reference information of the vulnerability Note: This field may return null, indicating that no valid values can be obtained. |
| VULDescribe | String | Vulnerability description Note: This field may return null, indicating that no valid values can be obtained. |
| Fix | String | Fix suggestion Note: This field may return null, indicating that no valid values can be obtained. |
| ProSupport | Integer | Product support status. The real-time status is returned. Note: This field may return null, indicating that no valid values can be obtained. |
| IsPublish | Integer | Specify whether the vulnerability is published as an emergency vulnerability. 1: Published as an emergency vulnerability; 0: Not an emergency vulnerability.Note: This field may return null, indicating that no valid values can be obtained. |
| ReleaseTime | String | Disclosure time of the vulnerability. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | The time when the vulnerability is added to the vulnerability database. Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | String | The last update time of the vulnerability in the database Note: This field may return null, indicating that no valid values can be obtained. |
| SubCategory | String | Sub-category of the vulnerability Note: This field may return null, indicating that no valid values can be obtained. |
Configuration Risk Objects from Configuration's Perspective
Used by actions: DescribeRiskCenterCFGViewCFGRiskList.
| Name | Type | Description |
|---|---|---|
| NoHandleCount | Integer | Impact assets. |
| Level | String | Risk level: low - low risk, high - high risk, middle - medium risk, info - note, extreme - critical. |
| RecentTime | String | Latest Recognition Time |
| FirstTime | String | First Recognition Time |
| AffectAssetCount | Integer | Status. 0-Unprocessed; 1-Disposed; 2-Ignored. |
| Id | String | Unique ID of Asset |
| From | String | Asset Subtype |
| Index | String | Front-end Index |
| AppId | String | User appid. |
| Nick | String | User Nickname Note: This field may return null, indicating that no valid values can be obtained. |
| Uin | String | User UIN Note: This field may return null, indicating that no valid values can be obtained. |
| CFGName | String | Configuration name. Note: This field may return null, indicating that no valid values can be obtained. |
| CheckType | String | Check type. Note: This field may return null, indicating that no valid values can be obtained. |
| CFGSTD | String | - Note: This field may return null, indicating that no valid values can be obtained. |
| CFGDescribe | String | Description Note: This field may return null, indicating that no valid values can be obtained. |
| CFGFix | String | Fixing suggestion Note: This field may return null, indicating that no valid values can be obtained. |
| CFGHelpURL | String | Help documentation. Note: This field may return null, indicating that no valid values can be obtained. |
Details of a server asset
Used by actions: DescribeCVMAssets.
| Name | Type | Required | Description |
|---|---|---|---|
| AssetId | String | No | Asset ID Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetName | String | No | Asset name Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetType | String | No | Asset type Note: This field may return·null, indicating that no valid values can be obtained. |
| Region | String | No | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| CWPStatus | Integer | No | Protection status Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetCreateTime | String | No | Asset creation time Note: This field may return·null, indicating that no valid values can be obtained. |
| PublicIp | String | No | Public IP Note: This field may return·null, indicating that no valid values can be obtained. |
| PrivateIp | String | No | Private IP Note: This field may return·null, indicating that no valid values can be obtained. |
| VpcId | String | No | vpc id |
| VpcName | String | No | VPC name Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | Integer | No | App ID Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | No | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| NickName | String | No | User name Note: This field may return·null, indicating that no valid values can be obtained. |
| AvailableArea | String | No | Availability zone Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCore | Integer | No | Whether it's a critical asset Note: This field may return·null, indicating that no valid values can be obtained. |
| SubnetId | String | No | Subnet ID Note: This field may return·null, indicating that no valid values can be obtained. |
| SubnetName | String | No | Subnet name Note: This field may return·null, indicating that no valid values can be obtained. |
| InstanceUuid | String | No | UUID of the instance Note: This field may return·null, indicating that no valid values can be obtained. |
| InstanceQUuid | String | No | QUuid of the instance Note: This field may return·null, indicating that no valid values can be obtained. |
| OsName | String | No | OS name Note: This field may return·null, indicating that no valid values can be obtained. |
| PartitionCount | Integer | No | Number of partitions Note: This field may return·null, indicating that no valid values can be obtained. |
| CPUInfo | String | No | CPU information Note: This field may return·null, indicating that no valid values can be obtained. |
| CPUSize | Integer | No | CPU size Note: This field may return·null, indicating that no valid values can be obtained. |
| CPULoad | String | No | CPU load Note: This field may return·null, indicating that no valid values can be obtained. |
| MemorySize | String | No | Memory size Note: This field may return·null, indicating that no valid values can be obtained. |
| MemoryLoad | String | No | Memory load Note: This field may return·null, indicating that no valid values can be obtained. |
| DiskSize | String | No | Disk size. Note: This field may return·null, indicating that no valid values can be obtained. |
| DiskLoad | String | No | Disk load Note: This field may return·null, indicating that no valid values can be obtained. |
| AccountCount | String | No | Number of accounts Note: This field may return·null, indicating that no valid values can be obtained. |
| ProcessCount | String | No | Number of processes Note: This field may return·null, indicating that no valid values can be obtained. |
| AppCount | String | No | Number of applications Note: This field may return·null, indicating that no valid values can be obtained. |
| PortCount | Integer | No | Number of listened ports. Note: This field may return·null, indicating that no valid values can be obtained. |
| Attack | Integer | No | Number of network attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| Access | Integer | No | Number of network access requests Note: This field may return·null, indicating that no valid values can be obtained. |
| Intercept | Integer | No | Number of blocked attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| InBandwidth | String | No | Inbound peak bandwidth Note: This field may return·null, indicating that no valid values can be obtained. |
| OutBandwidth | String | No | OutInbound peak bandwidth Note: This field may return·null, indicating that no valid values can be obtained. |
| InFlow | String | No | Total inbound traffic Note: This field may return·null, indicating that no valid values can be obtained. |
| OutFlow | String | No | Total outbound traffic Note: This field may return·null, indicating that no valid values can be obtained. |
| LastScanTime | String | No | Last scan time Note: This field may return·null, indicating that no valid values can be obtained. |
| NetWorkOut | Integer | No | Proactive malicious outgoing requests Note: This field may return·null, indicating that no valid values can be obtained. |
| PortRisk | Integer | No | Port risks Note: This field may return·null, indicating that no valid values can be obtained. |
| VulnerabilityRisk | Integer | No | Vulnerabilities Note: This field may return·null, indicating that no valid values can be obtained. |
| ConfigurationRisk | Integer | No | Configuraiton risks Note: This field may return·null, indicating that no valid values can be obtained. |
| ScanTask | Integer | No | Number of scan tasks Note: This field may return·null, indicating that no valid values can be obtained. |
| Tag | Array of Tag | No | Tags Note: This field may return·null, indicating that no valid values can be obtained. |
| MemberId | String | No | Member ID Note: This field may return·null, indicating that no valid values can be obtained. |
| Os | String | No | Full name of the operating system Note: This field may return·null, indicating that no valid values can be obtained. |
| RiskExposure | Integer | No | Risk exposure Note: This field may return·null, indicating that no valid values can be obtained. |
| BASAgentStatus | Integer | No | BAS toolkit status. 0: Not installed; 1: Installed; 2: Offline.Note: This field may return·null, indicating that no valid values can be obtained. |
| IsNewAsset | Integer | No | 1: New asset; 0: Not a new assetNote: This field may return·null, indicating that no valid values can be obtained. |
Record details.
Used by actions: DescribeAbnormalCallRecord, DescribeCallRecord.
| Name | Type | Description |
|---|---|---|
| CallID | String | Invocation record ID. |
| AccessKey | String | Access key. |
| AccessKeyRemark | String | Access key remark. |
| AccessKeyID | Integer | Access key ID. |
| SourceIP | String | Source IP of the call. |
| SourceIPRemark | String | Source IP of the call remark. |
| Region | String | Source IP region of the call. |
| IPType | Integer | IP type 0: within the account (unremarked) 1: outside the account (unremarked) 2: within the account (remarked) 3: outside the account (remarked). |
| EventName | String | Call interface name. |
| ProductName | String | Call the product name. |
| EventType | Integer | Invocation type. 0: console invocation. 1:API |
| UserType | String | Type of user: CAMUser/root/AssumedRole. |
| UserName | String | User/Role name. |
| PolicySet | Array of String | Policy List |
| CallCount | Integer | Number of calls. |
| Code | Integer | Error code. 0: Successful |
| FirstCallTime | String | First time call time. |
| LastCallTime | String | Call time. |
| InstanceID | String | IP associated asset ID. if an empty string, means not associated with. |
| InstanceName | String | Associated asset name of the IP. |
| Date | String | Aggregate date. |
| AppID | Integer | appid |
| ShowStatus | Boolean | Display status. |
| ISP | String | Carrier. |
| VpcInfo | Array of SourceIPVpcInfo | vpc information list outside the account. |
| ReqClient | Array of String | Request client list. |
CLB instance and listener information
Used by actions: DescribeListenerList.
| Name | Type | Description |
|---|---|---|
| ListenerId | String | Listener ID Note: This field may return·null, indicating that no valid values can be obtained. |
| ListenerName | String | The listener name. Note: This field may return·null, indicating that no valid values can be obtained. |
| LoadBalancerId | String | Load balancer ID Note: This field may return·null, indicating that no valid values can be obtained. |
| LoadBalancerName | String | CLB instance name Note: This field may return·null, indicating that no valid values can be obtained. |
| Protocol | String | Network protocol Note: This field may return·null, indicating that no valid values can be obtained. |
| Region | String | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| Vip | String | CLB instance IP Note: This field may return·null, indicating that no valid values can be obtained. |
| VPort | Integer | Port Note: This field may return·null, indicating that no valid values can be obtained. |
| Zone | String | Availability zone Note: This field may return·null, indicating that no valid values can be obtained. |
| NumericalVpcId | Integer | VPC ID Note: This field may return·null, indicating that no valid values can be obtained. |
| LoadBalancerType | String | CLB instance type Note: This field may return·null, indicating that no valid values can be obtained. |
| Domain | String | Listener domain name Note: This field may return·null, indicating that no valid values can be obtained. |
| LoadBalancerDomain | String | Load balancer domain name Note: This field may return·null, indicating that no valid values can be obtained. |
Multi-cloud account statistics
Used by actions: DescribeOrganizationInfo.
| Name | Type | Description |
|---|---|---|
| CloudType | Integer | 0 represents Tencent Cloud 1 represents AWS |
| CloudCount | Integer | Account quantity |
| CloudDesc | String | The cloud account type description |
Risk center risk overview statistics.
Used by actions: DescribeCSIPRiskStatistics.
| Name | Type | Description |
|---|---|---|
| PortTotal | Integer | Total Number of Port Risks |
| PortHighLevel | Integer | High Port Risk Count |
| WeakPasswordTotal | Integer | Total number of weak password risks. |
| WeakPasswordHighLevel | Integer | High Weak Password Risk Count |
| WebsiteTotal | Integer | Website Risk Count |
| WebsiteHighLevel | Integer | Number of High Risks on Websites |
| LastScanTime | String | Time of the Latest Scan |
| VULTotal | Integer | Number of vulnerability risks. |
| VULHighLevel | Integer | Number of High-Risk Vulnerability Risks |
| CFGTotal | Integer | Number of Configuration Item Risks |
| CFGHighLevel | Integer | Number of High-Risk Configuration Item Risks |
| ServerTotal | Integer | Mapping Service Risk Count Note: This field may return null, indicating that no valid values can be obtained. |
| ServerHighLevel | Integer | High Mapping Service Risk Count Note: This field may return null, indicating that no valid values can be obtained. |
| HostBaseLineRiskTotal | Integer | Number of host baseline risks. |
| HostBaseLineRiskHighLevel | Integer | Number of high-risk risks. |
| PodBaseLineRiskTotal | Integer | Baseline risk count of the container. |
| PodBaseLineRiskHighLevel | Integer | Number of high-risk baseline risks in the container. |
Details of a database asset
Used by actions: DescribeDbAssets, DescribeOtherCloudAssets.
| Name | Type | Description |
|---|---|---|
| AssetId | String | Asset ID |
| AssetName | String | Asset name. |
| AssetType | String | Asset type. |
| VpcId | String | vpcid |
| VpcName | String | vpc Tag. |
| Region | String | Region. |
| Domain | String | Domain |
| AssetCreateTime | String | Asset creation time. |
| LastScanTime | String | Last scan time |
| ConfigurationRisk | Integer | Configuration risk. |
| Attack | Integer | Network attack. |
| Access | Integer | Network access. |
| ScanTask | Integer | Scan Task |
| AppId | Integer | User appid. |
| Uin | String | User UIN |
| NickName | String | Nickname Alias |
| Port | Integer | Port. |
| Tag | Array of Tag | Tag. |
| PrivateIp | String | Private IP address |
| PublicIp | String | Public IP address |
| Status | Integer | Status. |
| IsCore | Integer | Core or Not |
| IsNewAsset | Integer | New Asset or Not. 1: New |
Vulnerability and asset information
Used by actions: DescribeSearchBugInfo.
| Name | Type | Description |
|---|---|---|
| StateCode | String | Query status code |
| DataBug | Array of BugInfoDetail | Note: This field may return·null, indicating that no valid values can be obtained. |
| DataAsset | Array of AssetInfoDetail | None Note: This field may return·null, indicating that no valid values can be obtained. |
| VSSScan | Boolean | true: Support vulnerability scan; false: Do not support vulnerability scanNote: This field may return·null, indicating that no valid values can be obtained. |
| CWPScan | String | 0: Do not support; 1: SupportNote: This field may return·null, indicating that no valid values can be obtained. |
| CFWPatch | String | 1: Support virtual patches; 0 or null: Do not supportNote: This field may return·null, indicating that no valid values can be obtained. |
| WafPatch | Integer | 0: Do not support; 1: SupportNote: This field may return·null, indicating that no valid values can be obtained. |
| CWPFix | Integer | 0: Do not support; 1: SupportNote: This field may return·null, indicating that no valid values can be obtained. |
Details of a database asset.
Used by actions: DescribeDbAssetInfo.
| Name | Type | Description |
|---|---|---|
| CFWStatus | Integer | CFW status Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetId | String | Asset ID Note: This field may return·null, indicating that no valid values can be obtained. |
| VpcName | String | VPC information Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetType | String | Asset type Note: This field may return·null, indicating that no valid values can be obtained. |
| PublicIp | String | Public IP Note: This field may return·null, indicating that no valid values can be obtained. |
| PrivateIp | String | Private IP Note: This field may return·null, indicating that no valid values can be obtained. |
| Region | String | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| VpcId | String | vpc information |
| AssetName | String | Asset name Note: This field may return·null, indicating that no valid values can be obtained. |
| CFWProtectLevel | Integer | CFW edition Note: This field may return·null, indicating that no valid values can be obtained. |
| Tag | Array of Tag | Tag information Note: This field may return·null, indicating that no valid values can be obtained. |
Domain assets
Used by actions: DescribeDomainAssets.
| Name | Type | Description |
|---|---|---|
| AssetId | Array of String | Asset ID Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetName | Array of String | Asset name Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetType | Array of String | Asset type Note: This field may return·null, indicating that no valid values can be obtained. |
| Region | Array of String | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| WAFStatus | Integer | WAF status Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetCreateTime | String | Asset creation time Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | Integer | Appid Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | Account ID Note: This field may return·null, indicating that no valid values can be obtained. |
| NickName | String | Account name Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCore | Integer | Whether it's a critical asset Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCloud | Integer | Whether it's a cloud asset Note: This field may return·null, indicating that no valid values can be obtained. |
| Attack | Integer | Network attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| Access | Integer | Network access Note: This field may return·null, indicating that no valid values can be obtained. |
| Intercept | Integer | Number of blocked attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| InBandwidth | String | Inbound peak bandwidth Note: This field may return·null, indicating that no valid values can be obtained. |
| OutBandwidth | String | Outbound peak bandwidth Note: This field may return·null, indicating that no valid values can be obtained. |
| InFlow | String | Total inbound traffic Note: This field may return·null, indicating that no valid values can be obtained. |
| OutFlow | String | Total outbound traffic Note: This field may return·null, indicating that no valid values can be obtained. |
| LastScanTime | String | Last scan time Note: This field may return·null, indicating that no valid values can be obtained. |
| PortRisk | Integer | Port risks Note: This field may return·null, indicating that no valid values can be obtained. |
| VulnerabilityRisk | Integer | Vulnerabilities Note: This field may return·null, indicating that no valid values can be obtained. |
| ConfigurationRisk | Integer | Configuration risks Note: This field may return·null, indicating that no valid values can be obtained. |
| ScanTask | Integer | Scan tasks Note: This field may return·null, indicating that no valid values can be obtained. |
| SubDomain | String | Domain name Note: This field may return·null, indicating that no valid values can be obtained. |
| SeverIp | Array of String | Resolved IP Note: This field may return·null, indicating that no valid values can be obtained. |
| BotCount | Integer | Bot access requests Note: This field may return·null, indicating that no valid values can be obtained. |
| WeakPassword | Integer | Weak password risks Note: This field may return·null, indicating that no valid values can be obtained. |
| WebContentRisk | Integer | Content risks Note: This field may return·null, indicating that no valid values can be obtained. |
| Tag | Array of Tag | Tags Note: This field may return·null, indicating that no valid values can be obtained. |
| SourceType | String | The type of associated instances. Note: This field may return·null, indicating that no valid values can be obtained. |
| MemberId | String | Member ID Note: This field may return·null, indicating that no valid values can be obtained. |
| CCAttack | Integer | CC attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| WebAttack | Integer | Web attack Note: This field may return·null, indicating that no valid values can be obtained. |
| ServiceRisk | Integer | Services exposed to risks Note: This field may return·null, indicating that no valid values can be obtained. |
| IsNewAsset | Integer | Whether it's a newly-added asset. Values: 1 (Yes), 0 (No)Note: This field may return·null, indicating that no valid values can be obtained. |
| VerifyDomain | String | Random third-level domain name of the asset pending ownership verification Note: This field may return·null, indicating that no valid values can be obtained. |
| VerifyTXTRecord | String | TXT record of the asset pending ownership verification Note: This field may return·null, indicating that no valid values can be obtained. |
| VerifyStatus | Integer | Ownership verification status of the asset. 0: Pending verification; 1: Verified; 2: Verifying; 3: TXT record verification failed; 4: Human verification failed.Note: This field may return·null, indicating that no valid values can be obtained. |
| BotAccessCount | Integer | u200cNumber of bot attacks Note: This field may return·null, indicating that no valid values can be obtained. |
Exposed asset category.
Used by actions: DescribeExposeAssetCategory.
| Name | Type | Description |
|---|---|---|
| Provider | String | Cloud service provider. |
| ProviderName | String | Vendor name. |
| AssetType | String | Asset type. |
| AssetTypeName | String | Asset type name. |
Exposed assets.
Used by actions: DescribeExposures.
| Name | Type | Description |
|---|---|---|
| Provider | String | Cloud service provider. |
| CloudAccountName | String | Account name. |
| CloudAccountId | String | Cloud account. |
| Domain | String | Domain |
| Ip | String | IP |
| Port | String | Port or port range. |
| Status | String | Open. |
| RiskType | String | Risk type. |
| AclType | String | acl type. |
| AclList | String | ACL list. |
| AssetId | String | Asset ID. |
| InstanceName | String | Instance name |
| AssetType | String | Asset type. |
| PortServiceCount | Integer | Port service quantity. |
| HighRiskPortServiceCount | Integer | Number of high-risk ports. |
| WebAppCount | Integer | Number of web applications. |
| RiskWebAppCount | Integer | Number of web applications at risk. |
| WeakPasswordCount | Integer | Number of Weak Passwords |
| VulCount | Integer | Number of vulnerabilities |
| CreateTime | String | First detection time |
| UpdateTime | String | Latest update time. |
| AssetTypeName | String | Instance Type Name |
| DisplayStatus | String | Open status. |
| DisplayRiskType | String | Port status. |
| ScanTaskStatus | String | Scan task status. |
| Uuid | String | uuid |
| HasScan | String | Whether a security check has been performed. |
| AppId | Integer | Tenant ID. |
| AppIdStr | String | Tenant ID string. |
| ExposureID | Integer | Record ID |
| PortDetectCount | Integer | Number of ports open. |
| PortDetectResult | String | Port exposure result. |
| Tag | String | Tag. |
| Comment | String | Remarks |
| ToGovernedRiskCount | Integer | Number of risks to be governed. |
| ToGovernedRiskContent | String | Risk content to be governed. |
Query filters
Used by actions: DescribeAbnormalCallRecord, DescribeAccessKeyAlarm, DescribeAccessKeyAsset, DescribeAccessKeyRisk, DescribeAccessKeyUserList, DescribeCSIPRiskStatistics, DescribeCVMAssets, DescribeCallRecord, DescribeClusterAssets, DescribeClusterPodAssets, DescribeDbAssets, DescribeDomainAssets, DescribeGatewayAssets, DescribeListenerList, DescribeNICAssets, DescribeOrganizationUserInfo, DescribeOtherCloudAssets, DescribePublicIpAssets, DescribeRepositoryImageAssets, DescribeRiskCallRecord, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterCFGViewCFGRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeScanReportList, DescribeScanTaskList, DescribeSourceIPAsset, DescribeSubUserInfo, DescribeSubnetAssets, DescribeTaskLogList, DescribeUserCallRecord, DescribeVULList, DescribeVULRiskAdvanceCFGList, DescribeVpcAssets, DescribeVulViewVulRiskList.
| Name | Type | Required | Description |
|---|---|---|---|
| Limit | Integer | No | Max number of returned results |
| Offset | Integer | No | Query offset |
| Order | String | No | Sorting order. Values: asc (ascending), desc (descending). |
| By | String | No | Specify the field used for sorting |
| Filters | Array of WhereFilter | No | Filtered columns and content |
| StartTime | String | No | Start time of the query period. |
| EndTime | String | No | End time of the query period. |
Filter condition
Used by actions: DescribeCVMAssets, DescribeClusterAssets, DescribeClusterPodAssets, DescribeDbAssets, DescribeDomainAssets, DescribeGatewayAssets, DescribeNICAssets, DescribeOrganizationUserInfo, DescribeOtherCloudAssets, DescribePublicIpAssets, DescribeRepositoryImageAssets, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterCFGViewCFGRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeScanTaskList, DescribeSubUserInfo, DescribeSubnetAssets, DescribeVULList, DescribeVULRiskAdvanceCFGList, DescribeVpcAssets, DescribeVulViewVulRiskList.
| Name | Type | Description |
|---|---|---|
| Value | String | Filter value |
| Text | String | Filter name |
Filters
Used by actions: DescribeAssetProcessList, DescribeExposures, DescribeHighBaseLineRiskList, DescribeVulRiskList.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Values | Array of String | No | Instance ID content. Note: This field may return null, indicating that no valid values can be obtained. |
| ExactMatch | String | No | Fuzzy matching. Note: This field may return null, indicating that no valid values can be obtained. |
Gateway asset.
Used by actions: DescribeGatewayAssets.
| Name | Type | Description |
|---|---|---|
| AppId | String | appid |
| Uin | String | uin |
| AssetId | String | Asset ID. |
| AssetName | String | Asset name. |
| AssetType | String | Asset type. |
| PrivateIp | String | VPC IP |
| PublicIp | String | Public IP address |
| Region | String | Region. |
| VpcId | String | VPC id. |
| VpcName | String | VPC Name |
| Tag | Array of Tag | Tag. |
| OutboundPeakBandwidth | String | Outbound peak bandwidth. |
| InboundPeakBandwidth | String | Inbound peak bandwidth. |
| OutboundCumulativeFlow | String | Cumulative Outbound Traffic |
| InboundCumulativeFlow | String | Cumulative Inbound Traffic |
| NetworkAttack | Integer | Network attack. |
| ExposedPort | Integer | Expose ports. |
| ExposedVUL | Integer | Exposed vulnerability. |
| ConfigureRisk | Integer | Configuration risk. |
| CreateTime | String | Creation time. |
| ScanTask | Integer | Number of tasks. |
| LastScanTime | String | Last scan time |
| Nick | String | Nickname. |
| AddressIPV6 | String | IPv6 address |
| IsCore | Integer | Core or Not |
| RiskExposure | Integer | Risk service exposure. |
| IsNewAsset | Integer | New Asset or Not. 1: New |
| Status | String | Gateway Status |
| EngineRegion | String | TSE's Actual Gateway Region |
| WeakPasswordRisk | Integer | Weak password risk. |
High-Risk baseline risk content.
Used by actions: DescribeHighBaseLineRiskList.
| Name | Type | Description |
|---|---|---|
| CloudAccountID | String | Cloud account ID. |
| AssetID | String | Instance ID. |
| InstanceStatus | String | Instance status |
| InstanceName | String | Instance name |
| RiskName | String | Risk name. |
| RiskCategory | String | Risk classification. |
| RiskLevel | String | Risk level. |
| RiskDesc | String | Risk description. |
| RiskResult | String | Risk result. |
| FixAdvice | String | Fixing suggestion |
| RiskCategoryName | String | Linux vulnerability. |
| RiskLevelName | String | Risk name. |
| InstanceStatusName | String | Instance status |
| CreateTime | String | First detection time |
| UpdateTime | String | Last discovery time |
| AppID | Integer | Tenant ID. |
List of IPs
Used by actions: DescribePublicIpAssets.
| Name | Type | Description |
|---|---|---|
| AssetId | String | Asset ID Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetName | String | Asset name Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetType | String | Asset type Note: This field may return·null, indicating that no valid values can be obtained. |
| Region | String | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| CFWStatus | Integer | CFW status Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetCreateTime | String | Asset creation time Note: This field may return·null, indicating that no valid values can be obtained. |
| PublicIp | String | Public IP Note: This field may return·null, indicating that no valid values can be obtained. |
| PublicIpType | Integer | Public IP type Note: This field may return·null, indicating that no valid values can be obtained. |
| VpcId | String | vpc |
| VpcName | String | VPC name Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | Integer | appid Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| NickName | String | Name Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCore | Integer | Whether it's a critical asset Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCloud | Integer | Whether it's a cloud asset Note: This field may return·null, indicating that no valid values can be obtained. |
| Attack | Integer | Number of network attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| Access | Integer | Number of network access requests Note: This field may return·null, indicating that no valid values can be obtained. |
| Intercept | Integer | Number of blocked attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| InBandwidth | String | Inbound bandwidth Note: This field may return·null, indicating that no valid values can be obtained. |
| OutBandwidth | String | Outbound bandwidthtraffic peak bandwidth (bps) Note: This field may return·null, indicating that no valid values can be obtained. |
| InFlow | String | Inbound traffic Note: This field may return·null, indicating that no valid values can be obtained. |
| OutFlow | String | Outbound traffic Note: This field may return·null, indicating that no valid values can be obtained. |
| LastScanTime | String | Last scan time Note: This field may return·null, indicating that no valid values can be obtained. |
| PortRisk | Integer | Port risks Note: This field may return·null, indicating that no valid values can be obtained. |
| VulnerabilityRisk | Integer | Vulnerabilities Note: This field may return·null, indicating that no valid values can be obtained. |
| ConfigurationRisk | Integer | Configuration risks Note: This field may return·null, indicating that no valid values can be obtained. |
| ScanTask | Integer | Scan tasks Note: This field may return·null, indicating that no valid values can be obtained. |
| WeakPassword | Integer | Weak passwords Note: This field may return·null, indicating that no valid values can be obtained. |
| WebContentRisk | Integer | Content risks Note: This field may return·null, indicating that no valid values can be obtained. |
| Tag | Array of Tag | Tags Note: This field may return·null, indicating that no valid values can be obtained. |
| AddressId | String | EIP ID Note: This field may return·null, indicating that no valid values can be obtained. |
| MemberId | String | Member ID Note: This field may return·null, indicating that no valid values can be obtained. |
| RiskExposure | Integer | Risk exposure Note: This field may return·null, indicating that no valid values can be obtained. |
| IsNewAsset | Integer | Whether it's a newly-added asset. Values: 1 (Yes), 0 (No)Note: This field may return·null, indicating that no valid values can be obtained. |
| VerifyStatus | Integer | Asset ownership verification status. 0: Pending verification; 1: Verified; 2: Verifying; 3 and above: Verification failedNote: This field may return·null, indicating that no valid values can be obtained. |
Network interface card asset.
Used by actions: DescribeNICAssets.
| Name | Type | Description |
|---|---|---|
| AppId | String | appid |
| Uin | String | uin |
| AssetId | String | Asset ID. |
| AssetName | String | Asset name. |
| AssetType | String | Asset type. |
| PrivateIp | String | VPC IP |
| PublicIp | String | Public IP address |
| Region | String | Region. |
| VpcId | String | VPC id. |
| VpcName | String | VPC Name |
| Tag | Array of Tag | Tag. |
| OutboundPeakBandwidth | String | Outbound peak bandwidth. |
| InboundPeakBandwidth | String | Inbound peak bandwidth. |
| OutboundCumulativeFlow | String | Cumulative Outbound Traffic |
| InboundCumulativeFlow | String | Cumulative Inbound Traffic |
| NetworkAttack | Integer | Network attack. |
| ExposedPort | Integer | Expose ports. |
| ExposedVUL | Integer | Exposed vulnerability. |
| ConfigureRisk | Integer | Configuration risk. |
| CreateTime | String | Creation time. |
| ScanTask | Integer | Number of tasks. |
| LastScanTime | String | Last scan time |
| Nick | String | Nickname. |
| IsCore | Integer | Core or Not |
| IsNewAsset | Integer | New Asset or Not. 1: New |
Group account details
Used by actions: DescribeOrganizationInfo.
| Name | Type | Description |
|---|---|---|
| NickName | String | Member account name |
| NodeName | String | Department node name, department of account |
| Role | String | Member/Admin/DelegatedAdmin/EntityAdmin; Member/Admin/DelegatedAdmin/EntityAdmin |
| MemberId | String | Member account id |
| JoinType | String | account joining method,create/invite |
| GroupName | String | Group name |
| AdminName | String | Admin account name |
| AdminUin | String | Admin Uin |
| CreateTime | String | Creation Time |
| NodeCount | Integer | Number of departments |
| MemberCount | Integer | Number of members |
| SubAccountCount | Integer | Sub-account count |
| AbnormalSubUserCount | Integer | Abnormal sub-account quantity |
| GroupPermission | Array of String | Organization Relationship Policy Permissions |
| MemberPermission | Array of String | Membership Policy Permissions |
| GroupPayMode | Integer | Organization Billing Mode; 0/Self-paid, 1/Proxy-paid |
| MemberPayMode | Integer | Personal Billing Mode; 0/Self-paid, 1/Proxy-paid |
| CFWProtect | String | If empty, it is not enabled; otherwise, different strings correspond to different versions, with 'common' being general and not version-specific. |
| WAFProtect | String | If empty, it is not enabled; otherwise, different strings correspond to different versions, with 'common' being general and not version-specific. |
| CWPProtect | String | If empty, it is not enabled; otherwise, different strings correspond to different versions, with 'common' being general and not version-specific. |
| Departments | Array of String | Array of all departments |
| MemberCreateTime | String | Member Creation Time |
| CSIPProtect | String | Advanced/Enterprise/Ultimate |
| QuotaConsumer | Integer | 1 indicates the quota consumer |
| EnableAdminCount | Integer | Number of enabled Admin/Delegated Admin accounts |
| CloudCountDesc | Array of CloudCountDesc | Multi-cloud account statistics in array format. Refer to the CloudCountDesc description for details. |
| AdminCount | Integer | Total Number of Admin/Delegated Admin Accounts |
Group Account Member Details
Used by actions: DescribeOrganizationUserInfo.
| Name | Type | Description |
|---|---|---|
| Uin | String | Member account Uin |
| NickName | String | Member account name |
| NodeName | String | Department node name, department of account |
| AssetCount | Integer | Asset Quantity |
| RiskCount | Integer | Risk Quantity |
| AttackCount | Integer | Attack Quantity |
| Role | String | Member/Admin/;Member or Administrator |
| MemberId | String | Member account id |
| AppId | String | Member account Appid |
| JoinType | String | account joining method,create/invite |
| CFWProtect | String | If empty, it is not enabled; otherwise, different strings correspond to different versions, with 'common' being general and not version-specific. |
| WAFProtect | String | If empty, it is not enabled; otherwise, different strings correspond to different versions, with 'common' being general and not version-specific. |
| CWPProtect | String | If empty, it is not enabled; otherwise, different strings correspond to different versions, with 'common' being general and not version-specific. |
| Enable | Integer | 1 enable, 0 not enabled |
| CSIPProtect | String | "Free" //Free edition "Advanced" //Advanced edition "Enterprise" //Enterprise edition "Ultimate" //Ultimate edition |
| QuotaConsumer | Integer | 1 indicates the quota consumer |
| CloudType | Integer | Account type: 0 for Tencent Cloud account, 1 for AWS account |
| SyncFrequency | Integer | 0 indicates the default value; 1 indicates 10 minutes; 2 indicates 1 hour; 3 indicates 24 hours |
| IsExpired | Boolean | Whether the multi-cloud account has expired |
| PermissionList | Array of String | Multi-cloud account permissions list |
| AuthType | Integer | 1 |
| TcMemberType | Integer | 0 Tencent Cloud group account 1 Tencent Cloud access account 2 non-Tencent Cloud |
| SubUserCount | Integer | Sub-account count |
| JoinTypeInfo | String | Joining method details |
Port Risk Advanced Configuration Item
Used by actions: CreateRiskCenterScanTask, ModifyRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| PortSets | String | Yes | Port Collection, separated by commas. |
| CheckType | Integer | Yes | Detection Item Type. 0-System-Defined; 1-User-Defined. |
| Detail | String | No | Detection item description |
| Enable | Integer | No | Enable/Disable. 1-Enable; 0-Disable. |
Port risk details
Used by actions: DescribeRiskCenterPortViewPortRiskList.
| Name | Type | Description |
|---|---|---|
| NoHandleCount | Integer | Affected assets |
| Level | String | Risk level |
| Protocol | String | Network protocol |
| Component | String | Components |
| Port | Integer | Port |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| Suggestion | Integer | Suggested action. 0: Keep as it is; 1: Block access requests; 2: Block the port |
| AffectAssetCount | String | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Unique ID of the asset |
| From | String | Asset sub-category |
| Index | String | Data entry key |
| AppId | String | User AppId |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| Service | String | Service |
List of public IPs/domain name assets
Used by actions: DeleteDomainAndIp.
| Name | Type | Required | Description |
|---|---|---|---|
| Asset | String | Yes | IP/Domain |
Report item
Used by actions: DescribeTaskLogURL.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskLogList | Array of String | Yes | List of report IDs. |
List of task IDs in the report
Used by actions: DescribeTaskLogURL.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskIdList | Array of String | Yes | List of task IDs |
| AppId | String | No | User AppId |
Repository Image List
Used by actions: DescribeRepositoryImageAssets.
| Name | Type | Required | Description |
|---|---|---|---|
| AppId | Integer | No | User appid. |
| Uin | String | No | User UIN |
| NickName | String | No | Nickname. |
| InstanceId | String | No | Mirror id. |
| InstanceName | String | No | Image name. |
| InstanceCreateTime | String | No | Image creation time. |
| InstanceSize | String | No | Image Size with Unit |
| BuildCount | Integer | No | Build times. |
| InstanceType | String | No | Image type. |
| AuthStatus | Integer | No | Authorization status. |
| InstanceVersion | String | No | Mirror version. |
| Region | String | No | Region. |
| RepositoryUrl | String | No | Repository address. |
| RepositoryName | String | No | Repository name. |
| IsCore | Integer | No | Core or Not |
| VulRisk | Integer | No | Vulnerability risk. |
| CheckCount | Integer | No | Check task. |
| CheckTime | String | No | Health Checkup Time |
| IsNewAsset | Integer | No | New Asset or Not. 1: New |
Risk call record details.
Used by actions: DescribeRiskCallRecord.
| Name | Type | Description |
|---|---|---|
| EventName | String | API name. |
| EventDescCN | String | Chinese description of the API. |
| EventDescEN | String | Interface description. |
| ProductName | String | Product name |
| ProductNameCN | String | Product Chinese Name |
| CallCount | Integer | Number of calls. |
Risk data
Used by actions: ModifyRiskCenterRiskStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | Yes | Risk ID |
| AppId | String | Yes | User AppId |
| PublicIPDomain | String | No | Public IP/domain name |
| InstanceId | String | No | Instance ID. |
Details of a scan task
Used by actions: DescribeScanReportList.
| Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID Id Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskName | String | Task name Note: This field may return·null, indicating that no valid values can be obtained. |
| Status | Integer | Task status. 1: Pending start; 2: Scanning; 3: Failed; 4: CompletedNote: This field may return·null, indicating that no valid values can be obtained. |
| Progress | Integer | Task progress Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskTime | String | Displayed time point Note: This field may return·null, indicating that no valid values can be obtained. |
| ReportId | String | Report ID Note: This field may return·null, indicating that no valid values can be obtained. |
| ReportName | String | Report name Note: This field may return·null, indicating that no valid values can be obtained. |
| ScanPlan | Integer | Task type. 0: Scheduled task, 1: Scan immediately; 2: Scanned at the specified time; 3: Custom. Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetCount | Integer | Number of associated assets Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | String | User AppId Note: This field may return·null, indicating that no valid values can be obtained. |
| UIN | String | User UIN Note: This field may return·null, indicating that no valid values can be obtained. |
| UserName | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
Data returned in the list of scan tasks list to display information
Used by actions: DescribeScanTaskList.
| Name | Type | Description |
|---|---|---|
| TaskName | String | Task name Note: This field may return null, indicating that no valid values can be obtained. |
| StartTime | String | Start time of the task Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | Task end time Note: This field may return null, indicating that no valid values can be obtained. |
| ScanPlanContent | String | CRON format Note: This field may return null, indicating that no valid values can be obtained. |
| TaskType | Integer | Task type. 0: Scheduled task, 1: Scan immediately; 2: Scanned at the specified time; 3: Custom.Note: This field may return null, indicating that no valid values can be obtained. |
| InsertTime | String | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
| TaskId | String | Task ID Note: This field may return null, indicating that no valid values can be obtained. |
| SelfDefiningAssets | Array of String | Custom list of assets to scan Note: This field may return null, indicating that no valid values can be obtained. |
| PredictTime | Integer | Estimated period to complete the task Note: This field may return null, indicating that no valid values can be obtained. |
| PredictEndTime | String | Estimated completion time of the task Note: This field may return null, indicating that no valid values can be obtained. |
| ReportNumber | Integer | Number of reports Note: This field may return null, indicating that no valid values can be obtained. |
| AssetNumber | Integer | Number of assets Note: This field may return null, indicating that no valid values can be obtained. |
| ScanStatus | Integer | Scanning status. 0: (default) Not scanned; 1: Scanning; 2: Scan completed; 3: Error while scanning; 4: Scanning stoppedNote: This field may return null, indicating that no valid values can be obtained. |
| Percent | Float | Task progress Note: This field may return null, indicating that no valid values can be obtained. |
| ScanItem | String | port/poc/weakpass/webcontent/configrisk Note: This field may return null, indicating that no valid values can be obtained. |
| ScanAssetType | Integer | Values: 0 (Scan all); 1 (Scan specific assets); 2 (Scan all expect the specified assets); 3 (Custom assets).Note: This field may return null, indicating that no valid values can be obtained. |
| VSSTaskId | String | VSS subtask ID Note: This field may return null, indicating that no valid values can be obtained. |
| CSPMTaskId | String | CSPM subtask ID Note: This field may return null, indicating that no valid values can be obtained. |
| CWPPOCId | String | CWPP vulnerability scan task IDHost missed scan subtask id Note: This field may return null, indicating that no valid values can be obtained. |
| CWPBlId | String | CWPP baseline check task ID Note: This field may return null, indicating that no valid values can be obtained. |
| VSSTaskProcess | Integer | VSS task progess Note: This field may return null, indicating that no valid values can be obtained. |
| CSPMTaskProcess | Integer | CSPM task progress Note: This field may return null, indicating that no valid values can be obtained. |
| CWPPOCProcess | Integer | CWPP vulnerability scan task progress Note: This field may return null, indicating that no valid values can be obtained. |
| CWPBlProcess | Integer | CWPP baseline check task progress Note: This field may return null, indicating that no valid values can be obtained. |
| ErrorCode | Integer | Exception status codes |
| ErrorInfo | String | Exception information Note: This field may return null, indicating that no valid values can be obtained. |
| StartDay | Integer | Day of the month to start the scheduled task Note: This field may return null, indicating that no valid values can be obtained. |
| Frequency | Integer | Scan frequency in days. 1: Every day; 7: Every seven days; 30: Every 30 days; 0: Scan once onlyNote: This field may return null, indicating that no valid values can be obtained. |
| CompleteNumber | Integer | Number of completed tasks Note: This field may return null, indicating that no valid values can be obtained. |
| CompleteAssetNumber | Integer | Number of scanned assets Note: This field may return null, indicating that no valid values can be obtained. |
| RiskCount | Integer | Number of risks Note: This field may return null, indicating that no valid values can be obtained. |
| Assets | Array of TaskAssetObject | Assets Note: This field may return null, indicating that no valid values can be obtained. |
| AppId | String | User AppidNote: This field may return null, indicating that no valid values can be obtained. |
| UIN | String | User UIN Note: This field may return null, indicating that no valid values can be obtained. |
| UserName | String | User name. Note: This field may return null, indicating that no valid values can be obtained. |
| TaskMode | Integer | Scan task mode: 0 (Standard), 1 (Quick), 2 (Advanced). Note: This field may return null, indicating that no valid values can be obtained. |
| ScanFrom | String | Source of scanning request Note: This field may return null, indicating that no valid values can be obtained. |
| IsFree | Integer | Whether it's a limited-time free health check. 0: No; 1: YesNote: This field may return null, indicating that no valid values can be obtained. |
| IsDelete | Integer | Whether the user is authorized to delete this task. 1 :Yes; 0: No. It's available for multi-account management.Note: This field may return null, indicating that no valid values can be obtained. |
| SourceType | Integer | Source of the task. 0: Default, 1: Assistant; 2: Health checkNote: This field may return null, indicating that no valid values can be obtained. |
Service risk
Used by actions: DescribeRiskCenterServerRiskList.
| Name | Type | Description |
|---|---|---|
| ServiceTag | String | Service tag |
| Port | Integer | Port Note: This field may return·null, indicating that no valid values can be obtained. |
| AffectAsset | String | Affected assets |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| InstanceType | String | Asset type |
| Level | String | Risk level |
| Protocol | String | Network protocol |
| Component | String | Components |
| Service | String | Service |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| RiskDetails | String | Risk Details Note: This field may return·null, indicating that no valid values can be obtained. |
| Suggestion | String | Handling suggestion |
| Status | Integer | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Unique ID of the asset |
| AppId | String | User appid |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| ServiceSnapshot | String | Service snapshot Note: This field may return·null, indicating that no valid values can be obtained. |
| Url | String | Service access URL. Note: This field may return·null, indicating that no valid values can be obtained. |
| Index | String | Data entry key Note: This field may return·null, indicating that no valid values can be obtained. |
| RiskList | Array of ServerRiskSuggestion | List of risks Note: This field may return·null, indicating that no valid values can be obtained. |
| SuggestionList | Array of ServerRiskSuggestion | List of fix suggestions Note: This field may return·null, indicating that no valid values can be obtained. |
| StatusCode | String | HTTP response code Note: This field may return·null, indicating that no valid values can be obtained. |
Risk details
Used by actions: DescribeRiskCenterServerRiskList.
| Name | Type | Description |
|---|---|---|
| Title | String | Risk title Note: This field may return·null, indicating that no valid values can be obtained. |
| Body | String | Risk details Note: This field may return·null, indicating that no valid values can be obtained. |
Product support.
Used by actions: DescribeVULRiskDetail.
| Name | Type | Description |
|---|---|---|
| ServiceName | String | Product name. "cfw_waf_virtual", "cwp_detect", "cwp_defense", "cwp_fix" |
| SupportHandledCount | Integer | Total number of processed assets. |
| SupportTotalCount | Integer | Total number of supported assets. |
| IsSupport | Boolean | Whether the product is supported: 1 for supported; 0 for unsupported. |
Access key asset information (source IP perspective).
Used by actions: DescribeSourceIPAsset.
| Name | Type | Description |
|---|---|---|
| ID | Integer | id of the source IP. |
| SourceIP | String | Source IP. |
| Remark | String | Remarks |
| AppID | Integer | Account associate APPID. |
| Region | String | IP region. |
| EventType | Integer | API call method. -1: uncounted. 0: console invocation. 1:API |
| IPType | Integer | IP type. 0: within the account (unremarked). 1: external accounts (unremarked). 2: within the account (remarked). 3: external account (remarked). |
| AccessKeyAlarmList | Array of AccessKeyAlarmInfo | Alarm information list. |
| AKInfo | Array of AKInfo | ak information list. |
| ActionCount | Integer | Number of API calls. |
| LastAccessTime | String | Last access Time |
| InstanceID | String | IP associated instance ID. if an empty string, represents an asset not within the account. |
| InstanceName | String | Associated instance name. |
| Uin | String | Account associate Uin. |
| Nickname | String | Nickname. |
| ShowStatus | Boolean | Display status. |
| ISP | String | ISP field. |
| VpcInfo | Array of SourceIPVpcInfo | vpc information outside the account. |
| CloudType | Integer | Cloud type. 0 for tencent cloud. |
Source IP of the call public account information.
Used by actions: DescribeAbnormalCallRecord, DescribeCallRecord, DescribeSourceIPAsset.
| Name | Type | Description |
|---|---|---|
| Name | String | Account name |
| AppID | Integer | App ID of the VPC. |
| VpcID | String | vpc id |
| VpcName | String | vpc name. |
Sub-account details
Used by actions: DescribeSubUserInfo.
| Name | Type | Description |
|---|---|---|
| ID | Integer | Primary key ID, which has no business meaning and serves solely as a unique identifier |
| AppID | String | sub-account Appid |
| Uin | String | sub-account UIn |
| NickName | String | Sub-account name |
| OwnerAppID | String | master account Appid |
| OwnerUin | String | master account Uin |
| OwnerNickName | String | master account name |
| OwnerMemberID | String | master account's memberId information |
| CloudType | Integer | Account type: 0 for Tencent Cloud account, 1 for AWS account |
| ServiceCount | Integer | Accessible services count |
| InterfaceCount | Integer | Accessible API count |
| AssetCount | Integer | Accessible resources count |
| LogCount | Integer | Access/Behavior Logs Count |
| ConfigRiskCount | Integer | Permissions configuration risk |
| ActionRiskCount | Integer | Dangerous behavior alarm |
| IsAccessCloudAudit | Boolean | whether to enable CloudAudit logs |
| IsAccessCheck | Boolean | whether risk configuration security assessment |
| IsAccessUeba | Boolean | whether to configure user behavior management policies |
Subnet assets
Used by actions: DescribeSubnetAssets.
| Name | Type | Description |
|---|---|---|
| AppId | String | appid |
| Uin | String | UIN |
| AssetId | String | Asset ID |
| AssetName | String | Asset name |
| Region | String | Region |
| VpcId | String | VPC ID |
| VpcName | String | VPC name |
| Tag | Array of Tag | Tags Note: This field may return·null, indicating that no valid values can be obtained. |
| Nick | String | User name |
| CIDR | String | CIDR block |
| Zone | String | Availability zone |
| CVM | Integer | Number of CVMs |
| AvailableIp | Integer | Number of available IPs |
| CreateTime | String | Creation time |
| ConfigureRisk | Integer | Configuration risks |
| ScanTask | Integer | Number of tasks. |
| LastScanTime | String | Last scan time |
| IsCore | Integer | Whether it's a critical asset Note: This field may return·null, indicating that no valid values can be obtained. |
| IsNewAsset | Integer | Whether it's a newly-added asset. Values: 1 (Yes), 0 (No)Note: This field may return·null, indicating that no valid values can be obtained. |
Tags
Used by actions: DescribeCVMAssetInfo, DescribeCVMAssets, DescribeDbAssetInfo, DescribeDbAssets, DescribeDomainAssets, DescribeGatewayAssets, DescribeNICAssets, DescribeOtherCloudAssets, DescribePublicIpAssets, DescribeSubnetAssets, DescribeVpcAssets.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Tag name. |
| Value | String | Yes | Tag value |
Server tag information
Used by actions: DescribeScanTaskList.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | None Note: This field may return·null, indicating that no valid values can be obtained. |
| TagValue | String | No | None Note: This field may return·null, indicating that no valid values can be obtained. |
Advanced task configuration
Used by actions: CreateRiskCenterScanTask, ModifyRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| PortRisk | Array of PortRiskAdvanceCFGParamItem | No | Port Risk Advanced Configuration |
| VulRisk | Array of TaskCenterVulRiskInputParam | No | Advanced vulnerability scan configuration |
| WeakPwdRisk | Array of TaskCenterWeakPwdRiskInputParam | No | Advanced weak password check configuration |
| CFGRisk | Array of TaskCenterCFGRiskInputParam | No | Advanced configuration risk scan configuration |
Task asset information
Used by actions: CreateRiskCenterScanTask, DescribeScanTaskList, ModifyRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| AssetName | String | No | Asset name. |
| InstanceType | String | No | Asset type. |
| AssetType | String | No | Asset category. |
| Asset | String | No | IP, domain name, asset ID, database ID, and more |
| Region | String | No | Region. |
| Arn | String | No | Unique ID of Multi-Cloud Assets |
Advanced configuration risk scan configuration
Used by actions: CreateRiskCenterScanTask, ModifyRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| ItemId | String | Yes | Check item ID |
| Enable | Integer | Yes | Whether to enable. 0: no, 1: yes. |
| ResourceType | String | Yes | Resource type |
Advanced vulnerability scan configuration
Used by actions: CreateRiskCenterScanTask, ModifyRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| RiskId | String | Yes | Risk ID |
| Enable | Integer | Yes | Whether to enable. 0: no, 1: yes. |
Advanced weak password check configuration
Used by actions: CreateRiskCenterScanTask, ModifyRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| CheckItemId | Integer | Yes | Check item ID |
| Enable | Integer | Yes | Whether to enable. 0: no, 1: yes. |
List of task IDs
Used by actions: DeleteRiskScanTask, StopRiskCenterTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskId | String | Yes | Task ID |
Task report information
Used by actions: DescribeTaskLogList.
| Name | Type | Description |
|---|---|---|
| TaskLogName | String | Report name Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskLogId | String | Report ID. |
| AssetsNumber | Integer | Number of associated assets Note: This field may return·null, indicating that no valid values can be obtained. |
| RiskNumber | Integer | Number of risks Note: This field may return·null, indicating that no valid values can be obtained. |
| Time | String | Report generation time Note: This field may return·null, indicating that no valid values can be obtained. |
| Status | Integer | Task status. 0: Initial value; 1: Scanning; 2: Completed; 3: Failed; 4: Stopped; 5: Paused; 6: RetriedNote: This field may return·null, indicating that no valid values can be obtained. |
| TaskName | String | Name of the associated task Note: This field may return·null, indicating that no valid values can be obtained. |
| StartTime | String | Scan start time Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskCenterTaskId | String | Scan task ID Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | String | User AppId Note: This field may return·null, indicating that no valid values can be obtained. |
| UIN | String | User UIN Note: This field may return·null, indicating that no valid values can be obtained. |
| UserName | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| ReportType | Integer | Report type: 1: Health check report; 2: Daily report; 3: Weekly report; 4: Monthly reportNote: This field may return·null, indicating that no valid values can be obtained. |
| TemplateId | Integer | Report template ID Note: This field may return·null, indicating that no valid values can be obtained. |
Temp download URL for the report PDF
Used by actions: DescribeTaskLogURL.
| Name | Type | Description |
|---|---|---|
| URL | String | Temp download URL for the report Note: This field may return·null, indicating that no valid values can be obtained. |
| LogId | String | Task report ID Note: This field may return·null, indicating that no valid values can be obtained. |
| TaskLogName | String | Task report name Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | String | APP ID Note: This field may return·null, indicating that no valid values can be obtained. |
Record details.
Used by actions: DescribeUserCallRecord.
| Name | Type | Description |
|---|---|---|
| SourceIP | String | Source IP of the call. |
| EventType | Integer | Invocation type. 0: console invocation. 1:API |
| CallCount | Integer | Number of calls. |
| Code | Integer | Error code. 0: Successful |
| FirstCallTime | String | First time call time. |
| LastCallTime | String | Call time. |
| SourceIPRemark | String | Source IP of the call remark. |
| Region | String | Source IP region of the call. |
| UserName | String | User/Role name. |
| Date | String | Aggregate date. |
| AppID | Integer | appid |
| ISP | String | Carrier. |
Emergency vulnerability basic data.
Used by actions: DescribeVULList.
| Name | Type | Description |
|---|---|---|
| Level | String | Risk level. High - high risk, middle - medium risk, low - low risk, info - Note. |
| Component | String | Component. |
| PublishTime | String | Release date. |
| LastScanTime | String | Last scan time |
| AffectAssetCount | Integer | Number of Affected Assets |
| RiskId | String | Risk ID |
| VULType | String | Vulnerability type. |
| VULName | String | Vulnerability name |
| CVE | String | cve |
| Describe | String | Description |
| Payload | String | Vulnerability Payload |
| AppName | String | Vulnerability impact component. |
| References | String | Technology reference. |
| AppVersion | String | Vulnerability impact version. |
| VULURL | String | Risks. |
| Nick | String | User Nickname Note: This field may return null, indicating that no valid values can be obtained. |
| AppId | String | User appid. |
| Uin | String | User UIN Note: This field may return null, indicating that no valid values can be obtained. |
| Fix | String | Fixing suggestion Note: This field may return null, indicating that no valid values can be obtained. |
| EMGCVulType | Integer | Emergency Vulnerability Type. 1-Emergency Vulnerability; 0-Non-emergency Vulnerability. Note: This field may return null, indicating that no valid values can be obtained. |
| CVSS | Float | CVSS score Note: This field may return null, indicating that no valid values can be obtained. |
| AttackHeat | Integer | Attack intensity. 0/1/2/3 Note: This field may return null, indicating that no valid values can be obtained. |
| ScanStatus | Integer | Detection status 0 unscanned 1 scan in progress 2 scan complete. Note: This field may return null, indicating that no valid values can be obtained. |
| IsSuggest | Integer | 1/0 whether compulsory. Note: This field may return null, indicating that no valid values can be obtained. |
| VulTag | Array of String | Tag. Note: This field may return null, indicating that no valid values can be obtained. |
| SupportProduct | String | Support products: "cfw_waf_virtual", "cwp_detect", "cwp_defense", "cwp_fix" (comma-separated). Note: This field may return null, indicating that no valid values can be obtained. |
| TaskId | String | Vulnerability detection task id. Note: This field may return null, indicating that no valid values can be obtained. |
| Index | String | Primary key Note: This field may return null, indicating that no valid values can be obtained. |
| PcmgrID | String | Vulnerability id old version. Note: This field may return null, indicating that no valid values can be obtained. |
| TvdID | String | Vulnerability id new version. Note: This field may return null, indicating that no valid values can be obtained. |
List of advanced vulnerability scan configurations
Used by actions: DescribeVULRiskAdvanceCFGList.
| Name | Type | Description |
|---|---|---|
| RiskId | String | Risk ID |
| VULName | String | Vulnerability name |
| RiskLevel | String | Risk level |
| CheckFrom | String | Source of the check task |
| Enable | Integer | Whether it's enabled. 1: Enable; 0: DisabledNote: This field may return·null, indicating that no valid values can be obtained. |
| VULType | String | Risk type. |
| ImpactVersion | String | Affected versions |
| CVE | String | CVE number Note: This field may return·null, indicating that no valid values can be obtained. |
| VULTag | Array of String | Vulnerability tag |
| FixMethod | Array of String | Fix solution Note: This field may return·null, indicating that no valid values can be obtained. |
| ReleaseTime | String | Disclosure time Note: This field may return·null, indicating that no valid values can be obtained. |
| EMGCVulType | Integer | Whether it's an emergency vulnerability. Values: 1 (emergency vulnerability); 0 (non-emergency vulnerabilityNote: This field may return·null, indicating that no valid values can be obtained. |
| VULDescribe | String | Vulnerability description Note: This field may return·null, indicating that no valid values can be obtained. |
| ImpactComponent | String | Affected components Note: This field may return·null, indicating that no valid values can be obtained. |
Vulnerability risk information.
Used by actions: DescribeVULRiskDetail.
| Name | Type | Description |
|---|---|---|
| Fix | String | Fixing suggestion |
| References | String | Technology reference/reference link. |
| Describe | String | Vulnerability description |
| ImpactComponent | Array of VulImpactComponentInfo | Affected component. |
Details of a vulnerability
Used by actions: DescribeRiskCenterVULViewVULRiskList.
| Name | Type | Description |
|---|---|---|
| Port | String | Port |
| NoHandleCount | Integer | Affected assets |
| Level | String | Risk level |
| Component | String | Components |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| AffectAssetCount | Integer | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Unique ID of the asset |
| From | String | Asset sub-category |
| Index | String | Frontend index |
| VULType | String | Vulnerability type |
| VULName | String | Vulnerability name |
| CVE | String | CVE number |
| Describe | String | Description |
| Payload | String | Pay load |
| AppName | String | Affected components |
| References | String | Reference information of the vulnerability |
| AppVersion | String | Affected version |
| VULURL | String | Vulnerability URL |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | String | User appid |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| Fix | String | Fix suggestion Note: This field may return·null, indicating that no valid values can be obtained. |
| EMGCVulType | Integer | Whether it's an emergency vulnerability. Values: 1 (emergency vulnerability); 0 (non-emergency vulnerabilityNote: This field may return·null, indicating that no valid values can be obtained. |
Vulnerability Risk Objects from Vulnerability's Perspective
Used by actions: DescribeVulViewVulRiskList.
| Name | Type | Description |
|---|---|---|
| Port | String | Port. |
| NoHandleCount | Integer | Impact assets. |
| Level | String | Risk level: low - low risk, high - high risk, middle - medium risk, info - note, extreme - critical. |
| Component | String | Component. |
| RecentTime | String | Latest Recognition Time |
| FirstTime | String | First Recognition Time |
| AffectAssetCount | Integer | Number of Affected Assets |
| RiskId | String | Risk ID |
| From | String | Scan Source. See API Return Enumeration Type for details. |
| Index | String | Front-end Index |
| VULType | String | Vulnerability type. |
| VULName | String | Vulnerability name |
| CVE | String | cve |
| Payload | String | Vulnerability Payload |
| AppName | String | Vulnerability impact component. |
| AppVersion | String | Vulnerability impact version. |
| VULURL | String | Risks. |
| Nick | String | User Nickname |
| AppId | String | User appid. |
| Uin | String | User UIN |
| EMGCVulType | Integer | Emergency Vulnerability Type. 1-Emergency Vulnerability; 0-Non-emergency Vulnerability. |
| CVSS | Float | CVSS score |
| PCMGRId | String | PCMGRId |
| VulTag | Array of String | Vulnerability tag. during searching, emergency mandatory parameter VulTag=SuggestRepair/EMGCVul. |
| DisclosureTime | String | Vulnerability disclosure time. |
| AttackHeat | Integer | Attack intensity. |
| IsSuggest | Integer | Whether a mandatory vulnerability: 1 - yes; 0 - no. |
| HandleTaskId | String | Disposal task id. |
| EngineSource | String | Engine source. |
| VulRiskId | String | New vulnerability risk id. |
| TvdID | String | New version vulnerability id. |
| IsOneClick | Integer | Is it possible to perform a one-click physical examination. valid values: 1-yes, 0-not allowed. |
List of VPCs
Used by actions: DescribeVpcAssets.
| Name | Type | Description |
|---|---|---|
| Subnet | Integer | Subnet (32-bit mask) |
| ConnectedVpc | Integer | Connected VPC (32-bit mask) |
| AssetId | String | Asset ID |
| Region | String | Region |
| CVM | Integer | CVM (only 32-bit) |
| Tag | Array of Tag | Tags Note: This field may return·null, indicating that no valid values can be obtained. |
| DNS | Array of String | DNS domain Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetName | String | Asset name |
| CIDR | String | CIDR block |
| CreateTime | String | Asset creation time |
| AppId | String | appid |
| Uin | String | UIN |
| Nick | String | User name |
| IsNewAsset | Integer | Whether it's a newly-added asset. Values: 1 (Yes), 0 (No)Note: This field may return·null, indicating that no valid values can be obtained. |
| IsCore | Integer | Whether it's a critical asset. 1: Yes; 2: NoNote: This field may return·null, indicating that no valid values can be obtained. |
Vulnerability impact component information.
Used by actions: DescribeVULRiskDetail.
| Name | Type | Description |
|---|---|---|
| Component | String | Component name |
| Version | String | Version name. |
Host vulnerability risk content.
Used by actions: DescribeVulRiskList.
| Name | Type | Description |
|---|---|---|
| CloudAccountID | String | Cloud account ID. |
| AssetID | String | Instance ID. |
| InstanceStatus | String | Instance status |
| InstanceName | String | Instance name |
| CreateTime | String | Creation time. |
| UpdateTime | String | Update time |
| VulName | String | Vulnerability name |
| VulCategory | String | Vulnerability type. |
| VulLevel | String | Vulnerability level |
| CveID | String | CVE id. |
| Description | String | Vulnerability description |
| ContainerID | String | Container ID. |
| Fix | String | Vulnerability risk remediation recommendation. |
| VulCategoryName | String | Linux vulnerability. |
| VulLevelName | String | Vulnerability level name. |
| InstanceStatusName | String | Instance status chinese information. |
| AppID | Integer | Tenant ID. |
Vulnerability trends, attack trend, users affected, affect assets.
Used by actions: DescribeVULRiskDetail.
| Name | Type | Description |
|---|---|---|
| AffectAssetCount | Integer | Number of affected assets. |
| AffectUserCount | Integer | Number of users affected. |
| AttackCount | Integer | Number of attacks. |
| Date | String | Time |
Details of a content risk
Used by actions: DescribeRiskCenterWebsiteRiskList.
| Name | Type | Description |
|---|---|---|
| AffectAsset | String | Affected assets |
| Level | String | Risk level |
| RecentTime | String | Last detected |
| FirstTime | String | First detected |
| Status | Integer | Status of the risk. 0: Not handled, 1: Handled; 2: Ignored |
| Id | String | Unique ID of the asset |
| Index | String | Frontend index |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| AppId | String | User appid |
| Nick | String | User name. Note: This field may return·null, indicating that no valid values can be obtained. |
| Uin | String | User uinNote: This field may return·null, indicating that no valid values can be obtained. |
| URL | String | URL of the risk |
| URLPath | String | URL of the risk file |
| InstanceType | String | Instance type |
| DetectEngine | String | Check type. |
| ResultDescribe | String | Result description. |
| SourceURL | String | Source URL |
| SourceURLPath | String | Source file URL |
Filter conditions.
Used by actions: DescribeAbnormalCallRecord, DescribeAccessKeyAlarm, DescribeAccessKeyAsset, DescribeAccessKeyRisk, DescribeAccessKeyUserList, DescribeCSIPRiskStatistics, DescribeCVMAssets, DescribeCallRecord, DescribeClusterAssets, DescribeClusterPodAssets, DescribeDbAssets, DescribeDomainAssets, DescribeGatewayAssets, DescribeListenerList, DescribeNICAssets, DescribeOrganizationUserInfo, DescribeOtherCloudAssets, DescribePublicIpAssets, DescribeRepositoryImageAssets, DescribeRiskCallRecord, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterCFGViewCFGRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeScanReportList, DescribeScanTaskList, DescribeSourceIPAsset, DescribeSubUserInfo, DescribeSubnetAssets, DescribeTaskLogList, DescribeUserCallRecord, DescribeVULList, DescribeVULRiskAdvanceCFGList, DescribeVpcAssets, DescribeVulViewVulRiskList.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter item |
| Values | Array of String | Yes | Filter value |
| OperatorType | Integer | No | Central platform definition:. 1 equal 2 larger than 3 less than 4 greater than or equal to 5 less than or equal to 6 not equal to 9 fuzzy matching 13 non-fuzzy matching 14 bitwise and. Exact match fills 7. fuzzy matching fills 9. |
フィードバック