Data Types
最后更新时间：2025-10-30 21:37:32
AssetBaseInfoResponse
Details of server assets
Used by actions: DescribeCVMAssetInfo.
| Name | Type | Description |
|---|---|---|
| VpcId | String | |
| 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. |
AssetClusterPod
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. |
AssetInfoDetail
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. |
AssetTag
Asset tags
Used by actions: CreateDomainAndIp, CreateRiskCenterScanTask, DeleteDomainAndIp, DescribeDomainAssets, DescribePublicIpAssets, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | Tag key. It supports alphanumeric characters and underscores (_). Note: This field may return·null, indicating that no valid values can be obtained. |
| TagValue | String | No | Tag value. It supports alphanumeric characters and underscores (_). Note: This field may return·null, indicating that no valid values can be obtained. |
AssetViewCFGRisk
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. |
AssetViewPortRisk
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 |
AssetViewVULRisk
Details of a vulnerability
Used by actions: DescribeRiskCenterAssetViewVULRiskList.
| 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. |
| VULType | String | Vulnerability type |
| Port | String | Port |
| Describe | String | Description |
| AppName | String | Components affected by the vulnerability |
| References | String | Reference information about the vulnerability |
| AppVersion | String | Version |
| VULURL | String | Vulnerability URL |
| VULName | String | Vulnerability name |
| CVE | String | CVE number |
| Fix | String | Fix suggestion |
| POCId | String | POC ID |
| From | String | Source of the task |
| CWPVersion | Integer | CWPP edition |
| IsSupportRepair | Boolean | Whether it can be fixed |
| IsSupportDetect | Boolean | Whether it can be detected |
| InstanceUUID | String | Instance UUID |
| Payload | String | Pay load |
| 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. |
AssetViewWeakPassRisk
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 |
BugInfoDetail
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. |
CVMAssetVO
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 | |
| 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. |
ClbListenerListInfo
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. |
CloudCountDesc
Used by actions: DescribeOrganizationInfo.
| Name | Type | Description |
|---|---|---|
| CloudType | Integer | |
| CloudCount | Integer | |
| CloudDesc | String |
DBAssetVO
Details of a database asset
Used by actions: DescribeDbAssets.
| 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. |
| VpcId | String | |
| VpcName | String | VPC tags 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. |
| Domain | String | Domain name 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. |
| LastScanTime | String | Last scan time 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. |
| Attack | Integer | Network attacks Note: This field may return·null, indicating that no valid values can be obtained. |
| Access | Integer | |
| ScanTask | Integer | Scan tasks Note: This field may return·null, indicating that no valid values can be obtained. |
| AppId | Integer | 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. |
| NickName | String | User name Note: This field may return·null, indicating that no valid values can be obtained. |
| Port | Integer | Port 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. |
| PrivateIp | String | Private IP 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. |
| Status | Integer | Status 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. |
| 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. |
DataSearchBug
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. |
DbAssetInfo
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 | |
| 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. |
DomainAssetVO
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. |
Filter
Query filters
Used by actions: DescribeCVMAssets, DescribeClusterPodAssets, DescribeDbAssets, DescribeDomainAssets, DescribeListenerList, DescribeOrganizationUserInfo, DescribePublicIpAssets, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeScanReportList, DescribeScanTaskList, DescribeSubUserInfo, DescribeSubnetAssets, DescribeTaskLogList, DescribeVULRiskAdvanceCFGList, DescribeVpcAssets.
| 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. |
FilterDataObject
Filter condition
Used by actions: DescribeCVMAssets, DescribeClusterPodAssets, DescribeDbAssets, DescribeDomainAssets, DescribeOrganizationUserInfo, DescribePublicIpAssets, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeScanTaskList, DescribeSubUserInfo, DescribeSubnetAssets, DescribeVULRiskAdvanceCFGList, DescribeVpcAssets.
| Name | Type | Description |
|---|---|---|
| Value | String | Filter value |
| Text | String | Filter name |
IpAssetListVO
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 | |
| 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. |
OrganizationInfo
Used by actions: DescribeOrganizationInfo.
| Name | Type | Description |
|---|---|---|
| NickName | String | |
| NodeName | String | |
| Role | String | |
| MemberId | String | |
| JoinType | String | |
| GroupName | String | |
| AdminName | String | |
| AdminUin | String | |
| CreateTime | String | |
| NodeCount | Integer | |
| MemberCount | Integer | |
| SubAccountCount | Integer | |
| AbnormalSubUserCount | Integer | |
| GroupPermission | Array of String | |
| MemberPermission | Array of String | |
| GroupPayMode | Integer | |
| MemberPayMode | Integer | |
| CFWProtect | String | |
| WAFProtect | String | |
| CWPProtect | String | |
| Departments | Array of String | |
| MemberCreateTime | String | |
| CSIPProtect | String | Advanced/Enterprise/Ultimate |
| QuotaConsumer | Integer | |
| EnableAdminCount | Integer | |
| CloudCountDesc | Array of CloudCountDesc | |
| AdminCount | Integer |
OrganizationUserInfo
Used by actions: DescribeOrganizationUserInfo.
| Name | Type | Description |
|---|---|---|
| Uin | String | |
| NickName | String | |
| NodeName | String | |
| AssetCount | Integer | |
| RiskCount | Integer | |
| AttackCount | Integer | |
| Role | String | |
| MemberId | String | |
| AppId | String | |
| JoinType | String | |
| CFWProtect | String | |
| WAFProtect | String | |
| CWPProtect | String | |
| Enable | Integer | |
| CSIPProtect | String | |
| QuotaConsumer | Integer | |
| CloudType | Integer | |
| SyncFrequency | Integer | |
| IsExpired | Boolean | |
| PermissionList | Array of String | |
| AuthType | Integer | 1 |
| TcMemberType | Integer | |
| SubUserCount | Integer | |
| JoinTypeInfo | String |
PortViewPortRisk
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 |
PublicIpDomainListKey
List of public IPs/domain name assets
Used by actions: DeleteDomainAndIp.
| Name | Type | Required | Description |
|---|---|---|---|
| Asset | String | Yes | IP/Domain |
ReportItemKey
Report item
Used by actions: DescribeTaskLogURL.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskLogList | Array of String | Yes | List of report IDs. |
ReportTaskIdList
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 |
RiskCenterStatusKey
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. |
ScanTaskInfo
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. |
ScanTaskInfoList
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 | |
| 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. |
ServerRisk
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. |
ServerRiskSuggestion
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. |
SubUserInfo
Used by actions: DescribeSubUserInfo.
| Name | Type | Description |
|---|---|---|
| ID | Integer | |
| AppID | String | |
| Uin | String | |
| NickName | String | |
| OwnerAppID | String | |
| OwnerUin | String | |
| OwnerNickName | String | |
| OwnerMemberID | String | |
| CloudType | Integer | |
| ServiceCount | Integer | |
| InterfaceCount | Integer | |
| AssetCount | Integer | |
| LogCount | Integer | |
| ConfigRiskCount | Integer | |
| ActionRiskCount | Integer | |
| IsAccessCloudAudit | Boolean | |
| IsAccessCheck | Boolean | |
| IsAccessUeba | Boolean |
SubnetAsset
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. |
Tag
Tags
Used by actions: DescribeCVMAssetInfo, DescribeCVMAssets, DescribeDbAssetInfo, DescribeDbAssets, DescribeDomainAssets, DescribePublicIpAssets, DescribeSubnetAssets, DescribeVpcAssets.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Tag name. |
| Value | String | Yes | Tag value |
Tags
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. |
TaskAdvanceCFG
Advanced task configuration
Used by actions: CreateRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| 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 |
TaskAssetObject
Task asset information
Used by actions: CreateRiskCenterScanTask, DescribeScanTaskList.
| Name | Type | Required | Description |
|---|---|---|---|
| AssetName | String | No | Asset name Note: This field may return·null, indicating that no valid values can be obtained. |
| InstanceType | String | No | Asset category Note: This field may return·null, indicating that no valid values can be obtained. |
| AssetType | String | No | Asset sub-category Note: This field may return·null, indicating that no valid values can be obtained. |
| Asset | String | No | IP, domain name, asset ID, database ID, and more |
| Region | String | No | Region Note: This field may return·null, indicating that no valid values can be obtained. |
| Arn | String | No | The ID specific for an asset synched from another cloud platform Note: This field may return·null, indicating that no valid values can be obtained. |
TaskCenterCFGRiskInputParam
Advanced configuration risk scan configuration
Used by actions: CreateRiskCenterScanTask.
| 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 |
TaskCenterVulRiskInputParam
Advanced vulnerability scan configuration
Used by actions: CreateRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| RiskId | String | Yes | Risk ID |
| Enable | Integer | Yes | Whether to enable. 0: no, 1: yes. |
TaskCenterWeakPwdRiskInputParam
Advanced weak password check configuration
Used by actions: CreateRiskCenterScanTask.
| Name | Type | Required | Description |
|---|---|---|---|
| CheckItemId | Integer | Yes | Check item ID |
| Enable | Integer | Yes | Whether to enable. 0: no, 1: yes. |
TaskIdListKey
List of task IDs
Used by actions: DeleteRiskScanTask, StopRiskCenterTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskId | String | Yes | Task ID |
TaskLogInfo
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. |
TaskLogURL
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. |
VULRiskAdvanceCFGList
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. |
VULViewVULRisk
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. |
Vpc
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. |
WebsiteRisk
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 |
WhereFilter
Filter conditions.
Used by actions: DescribeCVMAssets, DescribeClusterPodAssets, DescribeDbAssets, DescribeDomainAssets, DescribeListenerList, DescribeOrganizationUserInfo, DescribePublicIpAssets, DescribeRiskCenterAssetViewCFGRiskList, DescribeRiskCenterAssetViewPortRiskList, DescribeRiskCenterAssetViewVULRiskList, DescribeRiskCenterAssetViewWeakPasswordRiskList, DescribeRiskCenterPortViewPortRiskList, DescribeRiskCenterServerRiskList, DescribeRiskCenterVULViewVULRiskList, DescribeRiskCenterWebsiteRiskList, DescribeScanReportList, DescribeScanTaskList, DescribeSubUserInfo, DescribeSubnetAssets, DescribeTaskLogList, DescribeVULRiskAdvanceCFGList, DescribeVpcAssets.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter item |
| Values | Array of String | Yes | Filter value |
| OperatorType | Integer | No | 1: =; 2: >; 3: <; 4: ≥; 5: ≤; 6: ≠;7: Exact match; 9: Fuzzy match; 13: Non-fuzzy match; 14: AND |
文档反馈