tencent cloud

APIs

Cloud Virtual Machine
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
Tencent Cloud Lighthouse
History
Introduction
API Category
Making API Requests
Image APIs
Firewall APIs
Key APIs
Instance APIs
CCN APIs
Snapshot APIs
Other APIs
Cloud Disk APIs
Scene APIs
Package APIs
Quota APIs
Region APIs
Data Types
Error Codes
Auto Scaling
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
Batch Compute
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
Tencent Cloud Automation Tools
History
Introduction
API Category
Making API Requests
Remote Command APIs
Scheduled Execution APIs
Managed Instance APIs
Scenario APIs
Statistics APIs
Data Types
Error Codes
Edge Computing Machine
History
API Category
Making API Requests
Region APIs
Module APIs
Instance APIs
Image APIs
VPC APIs
Subnet APIs
Route Table APIs
CLB APIs
ENI APIs
EIP APIs
HAVIP APIs
Other API
Key APIs
Security Group APIs
Data Types
Error Codes
Tencent Kubernetes Engine
History
Introduction
API Category
Making API Requests
Elastic Cluster APIs
Resource Reserved Coupon APIs
Cluster APIs
Third-party Node APIs
Relevant APIs for Addon
Network APIs
Node APIs
Node Pool APIs
TKE Edge Cluster APIs
Cloud Native Monitoring APIs
Scaling group APIs
Super Node APIs
Other APIs
Data Types
Error Codes
TKE API 2022-05-01
Tencent Container Registry
History
Introduction
API Category
Making API Requests
Instance Management APIs
Namespace APIs
Access Control APIs
Instance Synchronization APIs
Tag Retention APIs
Trigger APIs
Helm Chart APIs
Image Repository APIs
Custom Account APIs
Data Types
Error Codes
Tencent Cloud Elastic Microservice
History
Introduction
API Category
Making API Requests
Environment APIs
ModifyIngress
Resource APIs
Application APIs
Service APIs
Application Deployment APIs
Access Policy APIs
Configuration file APIs
Log collecting APIs
Scaling Rule APIs
Application Version APIs
Other APIs
Workload APIs
Data Types
Error Codes
Serverless Cloud Function
History
Introduction
API Category
Making API Requests
Other APIs
Namespace APIs
Layer Management APIs
Async Event Management APIs
Trigger APIs
Function APIs
Function and Layer Status Description
Data Types
Error Codes
Event Bridge
History
Introduction
API Category
Making API Requests
Delivery Target APIs
Event Bus APIs
Event Rule APIs
Event Connector APIs
Data Transformer APIs
Event Storage APIs
Data Types
Error Codes
Cloud Object Storage
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
Cloud File Storage
History
Introduction
API Category
Snapshot APIs
File system APIs
Lifecycle APIs
Other APIs
Data Flow APIs
Making API Requests
Permission Group APIs
Service APIs
Scaling APIs
Data Migration APIs
Data Types
Error Codes
Cloud Block Storage
History
Introduction
API Category
Making API Requests
Snapshot APIs
Cloud Disk APIs
Data Types
Error Codes
Cloud HDFS
History
Introduction
API Category
Making API Requests
Other APIs
Permission group APIs
Permission rule APIs
Mount point APIs
Lifecycle rule APIs
File system APIs
Restoration task APIs
Data Types
Error Codes
Cloud Log Service
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
Kafka Task APIs
Kafka Data Subscription APIs
COS Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
TDSQL-C for MySQL
History
Introduction
API Category
Making API Requests
Instance APIs
Multi-Availability Zone APIs
Other APIs
Audit APIs
Database Proxy APIs
Backup and Recovery APIs
Parameter Management APIs
Billing APIs
serverless APIs
Resource Package APIs
Account APIs
Performance Analysis APIs
Data Types
Error Codes
TencentDB for MySQL
History
Introduction
API Category
Instance APIs
Making API Requests
Data Import APIs
Database Proxy APIs
Database Audit APIs
Security APIs
Task APIs
Backup APIs
Account APIs
Rollback APIs
Parameter APIs
Database APIs
Monitoring APIs
Log-related API
Data Types
Error Codes
TencentDB for MariaDB
History
Introduction
API Category
Making API Requests
Security Group APIs
Other APIs
Account APIs
Parameter Management APIs
Monitoring Management APIs
Instance Management APIs
Backup and Restoration APIs
Data Types
Error Codes
TencentDB for PostgreSQL
History
Introduction
API Category
Making API Requests
Instance APIs
Read-only Replica APIs
Backup and Recovery APIs
Parameter Management APIs
Security Group APIs
Performance Optimization APIs
Account APIs
Specification APIs
Network APIs
Data Types
Error Codes
TencentDB for SQL Server
History
Introduction
API Category
Making API Requests
Sales and fee related APIs
Instance Management related APIs
Operation and maintenance management related APIs
Network management related APIs
Account management related APIs
Database management related APIs
Security group management related APIs
Data security encryption related APIs
Parameter configuration related APIs
Extended Event related APIs
Log management related APIs
Read only instance management related APIs
Publish and subscribe related APIs
Backup related APIs
Data migration (cold standby migration) related APIs
Rollback related APIs
Data migration (DTS old version) related APIs
SQL Server Integration Services (SSIS) related APIs
Data Types
Error Codes
TDSQL for MySQL
History
Introduction
API Category
Security Group APIs
Other APIs
Making API Requests
TDSQL APIs
Data Types
Error Codes
Tencent Cloud Distributed Cache (Redis OSS-Compatible)
History
Introduction
API Category
Making API Requests
Instance APIs
Parameter Management APIs
Other APIs
Backup and Restoration APIs
Region APIs
Monitoring and Management APIs
Log APIs
Data Types
Error Codes
TencentDB for MongoDB
History
Introduction
API Category
Making API Requests
Instance APIs
Backup APIs
Account APIs
Other APIs
Task APIs
Introduction
Data Types
Error Codes
TencentDB for TcaplusDB
History
Introduction
API Category
Making API Requests
Table Group APIs
Other APIs
Table APIs
Cluster APIs
Data Types
Error Codes
Data Transfer Service
History
Introduction
API Category
Making API Requests
(NewDTS) Data Migration APIs
Data Sync APIs
Data Consistency Check APIs
(NewDTS) Data Subscription APIs
Data Types
Error Codes
DTS API 2018-03-30
TencentDB for DBbrain
History
Introduction
Introduction
API Category
Making API Requests
Session Killing APIs
Exception Detection APIs
Other APIs
Redis related APIs
Health Report Email Sending APIs
Space Analysis APIs
Security Audit APIs
Slow Log Analysis APIs
Database Audit APIs
Data Types
Error Codes
DBbrain APIs 2019-10-16
Virtual Private Cloud
History
Introduction
API Category
Making API Requests
VPC APIs
Route Table APIs
Elastic Public IP APIs
Elastic IPv6 APIs
Highly Available Virtual IP APIs
ENI APIs
Bandwidth Package APIs
NAT Gateway APIs
Direct Connect Gateway APIs
Cloud Connect Network APIs
Network ACL APIs
Network Parameter Template APIs
Network Detection-Related APIs
Flow Log APIs
Gateway Traffic Monitor APIs
Private Link APIs
Traffic Mirroring APIs
Other APIs
Subnet APIs
VPN Gateway APIs
Security Group APIs
Snapshot Policy APIs
Error Codes
Data Types
Cloud Load Balancer
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
Direct Connect
History
Introduction
API Category
Making API Requests
Direct Connect APIs
Data Types
Error Codes
Content Delivery Network
History
Introduction
API Category
Content Management APIs
Real-time Log APIs
Service Query APIs
Data Query APIs
Making API Requests
Log Query APIs
Domain Name Management APIs
Configuration Management APIs
Obsoleted APIs
Other APIs
Data Types
Error Codes
Global Application Acceleration Platform
History
Introduction
API Category
Rule APIs
Connection Group APIs
Making API Requests
Origin Server APIs
Listener APIs
Connection APIs
Certificate APIs
Other APIs
Data Types
Error Codes
Tencent Cloud Firewall
History
Introduction
API Category
Making API Requests
Intrusion Defense APIs
Access Control APIs
Other APIs
Enterprise Security Group APIs
Firewall Status APIs
Data Types
Error Codes
Tencent Cloud EdgeOne
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
Cloud Workload Protection Platform
History
Introduction
API Category
Asset Management APIs
Virus Scanning APIs
Abnormal Log-in APIs
Password Cracking APIs
Malicious Request APIs
High-Risk Command APIs
Local Privilege Escalation APIs
Reverse Shell APIs
Vulnerability Management APIs
New Baseline Management APIs
Baseline Management APIs
Advanced Defense APIs
Security Operation APIs
Expert Service APIs
Other APIs
Overview Statistics APIs
Settings Center APIs
Making API Requests
Intrusion Detection APIs
Data Types
Error Codes
Key Management Service
History
Introduction
API Category
Key APIs
Making API Requests
Asymmetric Key APIs
Data Types
Error Codes
Secrets Manager
History
Introduction
API Category
Making API Requests
Data Security APIs
Other APIs
Data Types
Error Codes
Captcha
History
Introduction
API Category
Making API Requests
Server APIs
Error Codes
Customer Identity and Access Management
History
Introduction
API Category
Making API Requests
User Management APIs
Data Sync APIs
Audit Management APIs
Data Types
Error Codes
Security Token Service
History
Introduction
API Category
Making API Requests
STS APIs
Data Types
Error Codes
SSL Certificates
History
Introduction
API Category
Making API Requests
Certificate APIs
Certificate Renewal (Certificate ID Unchanged) APIs
CSR APIs
Data Types
Error Codes
Private DNS
History
Introduction
API Category
Making API Requests
Private DNS APIs
Data Types
Error Codes
DNSPod
History
Introduction
API Category
Making API Requests
Line APIs
Package and Value-Added Service APIs
Batch Operation APIs
Group APIs
Record APIs
DNS Query Volume APIs
Alias APIs
Domain APIs
Data Types
Error Codes
Elastic MapReduce
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
Elasticsearch Service
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
Data Lake Compute
History
Introduction
API Category
Making API Requests
Data Table APIs
Task APIs
Metadata APIs
Service Configuration APIs
Permission Management APIs
Database APIs
Data Source Connection APIs
Data Optimization APIs
Data Engine APIs
Resource Group for the Standard Engine APIs
Data Types
Error Codes
Face Recognition
History
Introduction
API Category
Making API Requests
Face Detection and Analysis APIs
Facial Feature Localization APIs
Face Comparison APIs
Group Management APIs
Face Search APIs
Face Verification APIs
Image-based Liveness Detection (High Precision) APIs
Data Types
Error Codes
eKYC
History
Introduction
API Category
Making API Requests
Selfie Verification (Pure API) APIs
Selfie Verification (App SDK) APIs
Identity Verification (App SDK) APIs
Identity Verification(Mobile HTML5) APIs
AI Face Shield (Pure API) APIs
Other APIs
Data Types
Error Codes
Text To Speech
History
Introduction
API Category
Making API Requests
General Text-to-Speech APIs
Data Types
Error Codes
Tencent Machine Translation
History
Introduction
API Category
Making API Requests
APIs
Error Codes
Optical Character Recognition
History
Introduction
API Category
Making API Requests
Document Intelligent APIs
Card and Document OCR APIs
General Text OCR APIs
Vehicle Scene OCR APIs
Data Types
Error Codes
IoT Hub
History
Introduction
API Category
Making API Requests
Device Shadow APIs
Device APIs
CA Certificate APIs
Product APIs
Data Types
Error Codes
TDMQ for CKafka
History
Introduction
API Category
Making API Requests
Other APIs
ACL APIs
Instance APIs
Routing APIs
DataHub APIs
Topic APIs
Data Types
Error Codes
Cloud Message Queue
History
API Category
Making API Requests
Topic APIs
Queue APIs
Introduction
Data Types
Error Codes
Chat
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Short Message Service
History
Introduction
API Category
Making API Requests
SMS Mobile Number APIs
SMS Conversion Rate APIs
Status Pull APIs
SMS Statistics APIs
SMS Signature APIs
SMS Delivery APIs
SMS Template APIs
Data Types
Error Codes
SMS Callback APIs
Tencent Push Notification Service
Overview
API Overview
Call Method
Push APIs
Tag APIs
Account APIs
Statistics APIs
User Attribute APIs
Server-Side Error Codes
Server SDKs
API (Java)
Simple Email Service
History
Introduction
API Category
Making API Requests
Domain Verification APIs
Mail APIs
Template APIs
Statistics APIs
Sender Address APIs
Blocklist APIs
Sending Status Query APIs
Batch Task APIs
Custom Blocklist APIs
Data Types
Error Codes
Tencent Real-Time Communication
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
StreamLive
History
Introduction
API Category
Making API Requests
Input Management APIs
Input Security Group Management APIs
Channel Management APIs
Plan APIs
Watermark Management APIs
Statistics APIs
Data Types
Error Codes
StreamPackage
History
Introduction
API Category
Making API Requests
Channel Management APIs
Advertising Insertion Configuration Management APIs
Channel linear assembly management APIs
VOD remux task APIs
Usage Query APIs
HarvestJob Management APIs
Data Types
Error Codes
StreamLink
History
API Category
Making API Requests
Flow APIs
Data Types
Error Codes
Cloud Streaming Services
History
Introduction
API Category
Making API Requests
Live Pad APIs
Live Stream Mix APIs
Time Shifting APIs
Monitoring Data Query APIs
Billing Data Query APIs
Live Transcoding APIs
Delayed Playback Management APIs
Domain Name Management APIs
Watermark Management APIs
Certificate Management APIs
Stream Pulling APIs
Recording Management APIs
Live Callback APIs
Screencapturing and Porn Detection APIs
Authentication Management APIs
Live Stream Management APIs
Data Types
Error Codes
Video on Demand
History
Introduction
API Category
Other APIs
Media Processing APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Parameter Template APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
Media Processing Service
History
Introduction
API Category
Making API Requests
Processing Task Initiation APIs
Task Management APIs
Transcoding and Enhancement Template APIs
Watermark Template APIs
Screenshot Template APIs
Media AI Template APIs
Media AI—Hotword Lexicon APIs
Media AI—Sample Management APIs
Media Quality Inspection Template APIs
Live Streaming Recording Template APIs
Orchestration Management APIs
Data Statistics APIs
StreamLink—Security Group Management APIs
Other APIs
Image Processing Template APIs
AI Generation APIs
Other APIs
Data Types
Error Codes
Cloud Application Rendering
History
Introduction
API Category
Making API Requests
User APIs
Application Management APIs
Project Management APIs
Concurrency Management APIs
Stream Push Service APIs
Data Types
Error Codes
Game Multimedia Engine
History
Introduction
API Category
Usage APIs
Recording APIs
Making API Requests
Voice Chat APIs
Application APIs
Data Types
Error Codes
Tag
History
Introduction
API Category
Making API Requests
Write APIs
Read APIs
Project APIs
Data Types
Error Codes
Cloud Access Management
History
Introduction
API Category
Making API Requests
User APIs
Policy APIs
Role APIs
Identity Provider APIs
Data Types
Error Codes
CloudAudit
History
Introduction
API Category
Calling Method
CloudAudit APIs
Data Types
Error Codes
Tencent Cloud Organization
History
Introduction
API Category
Making API Requests
Organization Settings APIs
Department and Member Management APIs
Unified Member Login APIs
Member Access Management APIs
Organization Service Management APIs
Organization Management Policy APIs
Resource Sharing APIs
Identity Center Management APIs
Identity Center User Management APIs
Identity Center User Group Management APIs
Identity Center Management SCIM Synchronization APIs
Identity Center Single Sign-On Management APIs
Identity Center Permission Configuration Management APIs
Identity Center Multi-Account Authorization Management APIs
Identity Center Sub-User Synchronization Management APIs
Data Types
Error Codes
TCO API 2018-12-25
Tencent Cloud Observability Platform
History
Introduction
API Category
Making API Requests
Monitoring Data Query APIs
Alarm APIs
Legacy Alert APIs
Notification Template APIs
TMP APIs
Grafana Service APIs
Event Center APIs
TencentCloud Managed Service for Prometheus APIs
Monitoring APIs
Data Types
Error Codes
Real User Monitoring
History
Introduction
API Category
Making API Requests
Console APIs
Business System and Project Information APIs
Custom Speed Test APIs
Custom Event APIs
API Monitoring APIs
Exception Analysis APIs
Page View APIs
Static Resource Monitoring APIs
Log APIs
Page Performance APIs
Data Types
Error Codes
International Partners
History
Introduction
API Category
Making API Requests
Customer Management APIs
Credit Management APIs
Agent APIs
Bill Management APIs
Voucher Management APIs
Commission Management APIs
Data Types
Error Codes
Billing Center
API Category
Funds Management APIs
Order Management APIs
Resource Management APIs
Bill Management APIs
Cost Allocation Management APIs
Cost Management APIs
Making API Requests
Organization Account APIs
Data Types
Error Codes
TDSQL Boundless
History
Introduction
API Category
Making API Requests
Instance APIs
Security Group APIs
Task APIs
Backup APIs
Rollback APIs
Parameter APIs
Database APIs
Data Types
Error Codes
TDMQ for MQTT
History
Introduction
API Category
Making API Requests
Cluster APIs
Topic APIs
Authorization Policy APIs
User APIs
Client APIs
Message APIs
Message Enhancement Rule APIs
Data Types
Error Codes
Tencent HY
History
Introduction
API Category
Making API Requests
Hunyuan Text APIs
Hunyuan 3D APIs
Data Types
Error Codes
Smart Media Hosting
History
Introduction
API Category
Making API Requests
PaaS Service APIs
Official Cloud Disk APIs
Data Types
Error Codes
Quota Center
History
Introduction
API Category
Making API Requests
Alarm APIs
Data Types
Error Codes
Message Center
History
Introduction
API Category
Making API Requests
Message Subscription APIs
Data Types
Error Codes
Business Intelligence
History
Introduction
API Category
Making API Requests
Project Management APIs
Role APIs
Database Table APIs
Report Embedding APIs
Page Management APIs
Data Types
Error Codes
LLM Knowledge Engine Basic API
History
Introduction
API Category
Making API Requests
Atomic Capability APIs
Data Types
Error Codes
Tencent Cloud Agent Development Platform
History
API Category
Making API Requests
Atomic Capability APIs
Operation Optimization APIs
Document Library APIs
Q&A Database APIs
Knowledge Tag APIs
Application Management APIs
Enterprise Management APIs
Billing APIs
Release Management APIs
Dialogue Endpoint APIs
Data Statistics APIs
Data Types
Error Codes
Tencent Cloud Blockchain as a Service
History
Introduction
API Category
Making API Requests
Hyperledger Fabric 2.3 APIs
Data Types
Error Codes
Performance Testing Service
History
Introduction
API Category
Making API Requests
PTS-related APIs
Data Types
Error Codes
Real-time Teleoperation
History
Introduction
API Category
Making API Requests
Project APIs
Device APIs
Session APIs
Authorization APIs
Other APIs
Data Types
Error Codes
Gateway Load Balancer
History
Introduction
API Category
Making API Requests
Target Group APIs
GWLB APIs
Other APIs
Data Types
Error Codes
Identity Aware Platform
History
Introduction
API Category
Making API Requests
IAP APIs
Error Codes
Cloud Dedicated Cluster
History
Introduction
API Category
Making API Requests
Cloud Dedicated Cluster (CDC) APIs
Data Types
Error Codes
Image Creation Large Model
History
Introduction
API Category
Making API Requests
Image Style Transfer APIs
Data Types
Error Codes
Face Fusion
API Category
Making API Requests
Image Face Fusion (Basic) APIs
Video Face Fusion (Single Face) APIs
Data Types
Error Codes
Tencent Smart Advisor-Chaotic Fault Generator
History
Introduction
API Category
Making API Requests
Task APIs
Template Library APIs
Data Types
Error Codes
Tencent HealthCare Omics Platform
History
Introduction
API Category
Making API Requests
Environment Management APIs
Tencent Healthcare Omics Platform APIs
Data Types
Error Codes
Tencent Cloud TCHouse-D
History
Introduction
API Category
Making API Requests
Cluster Operation APIs
Database and Table APIs
Cluster Information Viewing APIs
Hot-Cold Data Layering APIs
Database and Operation Audit APIs
User and Permission APIs
Resource Group Management APIs
Data Types
Error Codes
Tencent Cloud WeData
History
Introduction
API Category
Making API Requests
Project Management APIs
Smart Ops Related Interfaces
Resource Group APIs
Data Development APIs
Data Asset - Data Dictionary APIs
Data Development APIs
Ops Center APIs
Data Exploration APIs
Data Operations Related Interfaces
Asset APIs
Metadata Related Interfaces
Task Operations APIs
Data Security APIs
Instance Operation and Maintenance Related Interfaces
Data Map and Data Dictionary APIs
Data Quality Related Interfaces
DataInLong APIs
Platform Management APIs
Data Source Management APIs
Data Quality APIs
Platform Management APIs
Asset Data APIs
Data Source Management APIs
Data Types
Error Codes
WeData API 2025-08-06
Anti-DDoS
History
Introduction
API Category
Making API Requests
Anti-DDoS Advanced Instance APIs
Resource List APIs
Protection Configuration APIs
Other APIs
Alarm Notification APIs
Connection Configuration APIs
Intelligent Scheduling APIs
Black hole unblocking APIs
Statistical Report APIs
Data Types
Error Codes
Cloud Contact Center
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Tencent Cloud Super App as a Service
History
Introduction
API Category
Making API Requests
Operation Management APIs
Platform Management APIs
Sensitive API-Related APIs
Role Management APIs
Team Management APIs
Other Console APIs
Mini Program or Mini Game APIs
Management-Sensitive APIs
Global Domain Management APIs
Superapp APIs
User Management APIs
Data Types
Tencent Cloud Smart Advisor
History
Introduction
API Category
Making API Requests
Other APIs
Task APIs
Cloud Architecture Console APIs
Data Types
Error Codes
TDMQ for RabbitMQ
History
Introduction
API Category
Making API Requests
Relevant APIs for RabbitMQ Serverless PAAS Capacity
RabbitMQ Serverless Instance Management APIs
Data Types
Error Codes
Control Center
History
Introduction
API Category
Making API Requests
Account Factory APIs
Data Types
Error Codes
TDMQ for CMQ
API Documentation
API 2.0 to 3.0 Switch Guide
Tencent Cloud TCHouse-P
History
Introduction
API Category
Making API Requests
Information Query APIs
Instance APIs
Query APIs
Cluster Management APIs
Cluster Operation APIs
Data Types
Error Codes
TDMQ for RocketMQ
History
API Category
Making API Requests
Topic APIs
Consumer Group APIs
Message APIs
Role Authentication APIs
Hitless Migration APIs
Cloud Migration APIs
Cluster APIs
Data Types
Error Codes
Cloud Dedicated Zone
History
Introduction
API Category
Making API Requests
Availability Zone APIs
Data Types
Error Codes
Tencent Cloud Health Dashboard
History
Introduction
API Category
Making API Requests
Event APIs
Data Types
Error Codes
Application Performance Management
History
Introduction
API Category
Making API Requests
Application APIs
Business System APIs
General Query APIs
Unavailable APIs
Performance Analysis APIs
Data Types
Error Codes
Config
History
Introduction
API Category
Making API Requests
Rule APIs
Resource APIs
Data Types
Error Codes
Automatic Speech Recognition
History
Introduction
API Category
Making API Requests
Recording Recognition APIs
Real-Time Speech Recognition APIs
Data Types
Error Codes
Tencent Cloud TI Platform
History
Introduction
API Category
Making API Requests
Online Service APIs
Data Types
Error Codes
Web Application Firewall
History
Introduction
API Category
Making API Requests
Asset Management APIs
Billing APIs
Protection Settings APIs
Other APIs
IP Management APIs
Integration APIs
Log Service APIs
Security Overview APIs
Rule Engine APIs
Data Types
Error Codes
Cloud Security Center
History
Introduction
API Category
Making API Requests
Multi-account management related APIs
Scan Task APIs
Risk Center APIs
Asset Center APIs
Cloud Boundary Analysis APIs
Cloud API Anomaly Detection APIs
Report Download APIs
Solid Protection APIs
Cloud Security Center Overview APIs
Data Types
Error Codes
Risk Control Engine
History
Introduction
API Category
Making API Requests
TencentCloud API APIs
Data Types
Error Codes
TencentDB for CTSDB
History
Introduction
API Category
Making API Requests
Instance APIs
Database APIs
Data Types
Error Codes
Tencent Interactive Whiteboard
History
Introduction
API Category
Making API Requests
Whiteboard Push APIs
Other APIs
Document Transcoding APIs
Real-Time Recording APIs
Statistics Query APIs
Whiteboard Snapshot APIs
Recording Video Generation APIs
Data Types
Error Codes
Tencent Container Security Service
History
Introduction
API Category
Making API Requests
Network Security APIs
Cluster Security APIs
Security Compliance APIs
Runtime security - High-risk syscalls
Runtime Security - Reverse Shell APIs
Runtime Security APIs
Alert Settings APIs
Advanced prevention - K8s API abnormal requests
Asset Management APIs
Security Operations - Log Analysis APIs
Runtime Security - Trojan Call APIs
Runtime Security - Container Escape APIs
Image Security APIs
Billing APIs
Data Types
Error Codes
Domains
History
Introduction
API Category
Making API Requests
Domain Management APIs
Domain Query APIs
Bulk Operation APIs
Registrant Profile APIs
Other APIs
Data Types
Error Codes
Low-code Interactive Classroom
History
Introduction
API Category
Making API Requests
User Login APIs
Room Management APIs
Group Management APIs
Application Configuration APIs
Recording Management APIs
Courseware Management APIs
User Management APIs
Developer APIs
Data Types
Error Codes

API Category

Mode fokus
Ukuran font
Terakhir diperbarui: 2026-03-23 11:09:16

Asset Management APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeAssetMachineList Obtains the list of resource monitoring 20
DescribeAssetMachineDetail Obtains asset management host resource details 20
DescribeAssetUserList Obtains the list of accounts 20
DescribeAssetUserInfo Obtain host account details 20
DescribeAssetPortInfoList Obtains the list of asset management ports 20
DescribeAssetProcessInfoList Obtains the list of asset management processes 20
DescribeAssetAppList Queries the application list 20
DescribeAssetAppProcessList Obtains the list of software's associated processes 20
DescribeAssetDatabaseList Queries the list of asset management databases 20
DescribeAssetDatabaseInfo Obtains the asset management database details 20
DescribeAssetWebAppList Obtains the list of asset management web applications 20
DescribeAssetWebServiceInfoList Queries the list of asset management Web services 20
DescribeAssetWebAppPluginList Obtains the list of asset management Web application plugins 20
DescribeAssetWebServiceProcessList Obtains the list of processes associated with Web services 20
DescribeAssetWebFrameList Obtains the list of asset management web frameworks 20
DescribeAssetWebLocationList Obtains the list of Web sites 20
DescribeAssetWebLocationInfo Obtains the Web site details 20
DescribeAssetJarList Queries the list of Jar packages 20
DescribeAssetJarInfo Obtains Jar package details 20
DescribeAssetInitServiceList Queries the list of asset management start services 20
DescribeAssetPlanTaskList Queries the list of asset management plan tasks 20
DescribeAssetCoreModuleList Queries the list of asset management kernel modules 20
DescribeAssetCoreModuleInfo Obtains kernel module details 20
DescribeAssetSystemPackageList Obtains the list of system installation packages for asset management 20
SyncAssetScan Synchronizes the asset scan information 20
DescribeAssetRecentMachineInfo Obtains the trend of host overview 20
DescribeAssetMachineTagTop Obtains top 5 host tags 20
DescribeAssetLoadInfo Obtains the resource load overview 20
DescribeAssetTypeTop Obtains Top5 resources of various types 20
ExportAssetRecentMachineInfo Exports host trends 20
DescribeMachineGeneral Queries the information of the host overview 20
DescribeMachineRegions Obtains the list of machine regions 20
DescribeMachineOsList Queries the machine operating system list 20
DescribeMachineLicenseDetail Queries the machine authorization information 20
DescribeMachines Obtains the list of hosts in a specific region 20
DescribeMachinesSimple Obtains the list of hosts 20
DescribeDirectConnectInstallCommand Obtains DC agent installation command 20
DescribeAgentInstallationToken Obtains the token for installing the agent in a hybrid cloud environment 20
RemoveMachine Cleans up the host information 20
DescribeHostInfo Queries the host and tag information 20
EditTags Adds or edits tags 20
DescribeTags Obtains all host tags 20
DeleteTags Deletes tags 20
DeleteMachineTag Deletes tags associated with the server 20
UpdateMachineTags List of tags associated with machines 20
DescribeTagMachines Obtains the server information associated with the specified tag 20
ExportAssetUserList Exports the account list 20
DescribeAssetUserCount Obtains the total number of accounts 20
ExportAssetMachineList Exports the list of resource monitoring 20
ExportAssetMachineDetail Exports asset management host resource details 20
DescribeAssetPortCount Obtains the total number of ports 20
ExportAssetPortInfoList Exports the list of asset management ports 20
DescribeAssetProcessCount Obtains the total number of processes 20
DescribeProcessStatistics Obtains the process statistics data 20
ExportAssetProcessInfoList Exports the asset management process list 20
DescribeAssetAppCount Obtains the number of all software applications 20
ExportAssetAppList Export the list of asset management applications 20
DescribeAssetDatabaseCount Obtains the number of all databases 20
ExportAssetDatabaseList Exports the list of asset management databases 20
DescribeAssetWebAppCount Obtains the number of all web applications 20
ExportAssetWebAppList Exports the list of asset management Web applications 20
DescribeAssetWebServiceCount Obtains the number of all web services 20
ExportAssetWebServiceInfoList Exports the list of asset management Web services 20
DescribeAssetWebLocationCount Obtains the total number of Web sites 20
ExportAssetWebLocationList Exports the list of Web sites 20
DescribeAssetWebLocationPathList Obtains the list of Web sites' virtual directories 20
DescribeAssetWebFrameCount Obtains the number of all Web frameworks 20
ExportAssetWebFrameList Exports the list of asset management Web frameworks 20
ExportAssetCoreModuleList Exports the list of asset management kernel modules 20
DescribeAssetDiskList Obtains the host disk partition list 20
DescribeFileTamperRules List of core file monitoring rules 20
DescribeMachineFileTamperRules Queries host-related core file monitoring rules 20
ExportAssetEnvList Exports the list of asset management environment variables 20
DescribeAssetHostTotalCount Obtains the total number of resources of the host 20
DescribeAssetTotalCount Obtains the number of resources 20
ExportAssetInitServiceList Exports the list of asset management startup services 20
ExportAssetJarList Exports the list of Jar packages 20
ExportAssetPlanTaskList Exports the list of scheduled asset management tasks 20
ExportAssetSystemPackageList Exports the list of system installation packages for asset management 20
DescribeAssetUserKeyList Obtains the list of host account Keys 20
DescribeOpenPortStatistics Obtains the list of port statistics 20
DescribeComponentStatistics Obtains the list of component statistics 20
DescribeHistoryAccounts Obtains the account change history list 20
DescribeAccountStatistics Obtains the account statistics data 20
DeleteMachineClearHistory Deletes clearing records of a machine 20
DescribeAssetInfo Obtains the number of assets 20
ModifyMachineAutoClearConfig Modifies the cleanup configuration of the machine 20
DescribeExportMachines Exports the list of hosts in a specific region 20
DescribeMachineClearHistory Queries the clearing history records of a machine 20
DeleteMachine Uninstalls the CWPP client 20
CreateIncidentBacktracking Triggers event investigation backtracking 20
DescribeMachineRegionList Queries the list of host regions 20

Virus Scanning APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeMalWareList Obtains the Trojan list 20
DescribeMalwareInfo Views malicious file details 20
DeleteMalwares Deletes Trojan records 20
TrustMalwares Trusts Trojan files 20
DescribeMalwareWhiteList Obtains the list of Trojan allowlists 20
DescribeNetAttackWhiteList Obtains the network attack allowlist list 20
DescribeMalwareWhiteListAffectList Obtains the list of affected Trojan allowlists 20
UntrustMalwares Untrusts Trojan files 20
DeleteMalwareWhiteList Deletes the Trojan whitelist 20
DeleteNetAttackWhiteList Deletes the network attack allowlist 20
SeparateMalwares Isolates Trojans 20
RecoverMalwares Recovers Trojan files 20
DescribeMalwareFile Obtains Trojan file download addresses 20
CreateScanMalwareSetting Detects the virus scanning 20
DeleteMalwareScanTask Terminates the scan tasks 20
DescribeScanMalwareSchedule Queries the Trojan scan progress 20
DescribeMalwareRiskWarning Risk warning prompt 20
ModifyMalwareTimingScanSettings Sets scheduled scan 20
DescribeMalwareTimingScanSetting Queries scheduled scan configuration 20
DescribeServersAndRiskAndFirstInfo Obtains virus scanning overview information 20
DescribeVulDefenceSetting Obtains the current vulnerability defense plugin settings 20
DescribeVulDefencePluginExceptionCount Obtains the current number of abnormal plugins 20
DescribeVulDefenceOverview Obtains the vulnerability defense overview information 20
DescribeJavaMemShellList Queries the list of Java webshell events 20
ModifyJavaMemShellsStatus Modifies the Java webshell event status 20
DescribeJavaMemShellPluginList Queries the Java webshell plugin list 20
DeleteAllJavaMemShells Deletes all Java webshell events 20
DescribeJavaMemShellInfo Queries Java webshell event details 20
DescribeJavaMemShellPluginInfo Queries the Java webshell plugin information of the given host 20
ModifyJavaMemShellPluginSwitch Enables and disables Java webshell plugins 20
CreateMalwareWhiteList Creates a Trojan allowlist 20
CreateNetAttackWhiteList Creates a network attack allowlist 20
DescribeMalwareRiskOverview Obtains the information of virus scanning overview 20
DescribeRiskProcessEvents Obtains the list of abnormal processes 20
ModifyMalwareWhiteList Edits the Trojan allowlist 20
ModifyNetAttackWhiteList Edits the network attack whitelist 20
ExportJavaMemShellPlugins Exports the Java webshell plugin information 20
ExportJavaMemShells Exports the list of Java webshell events 20
ExportMalwares Exports Trojan records 20
ExportRiskProcessEvents Exports abnormal process events 20

Abnormal Log-in APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteNonlocalLoginPlaces Deletes cross-region log-in records 20
DescribeLoginWhiteCombinedList Obtains the list of cross-region log-in allowlists after merge 20
ModifyLoginWhiteRecord Updates the log-in audit record information 20
DescribeLoginWhiteList Obtains the cross-region log-in allowlist list 20
AddLoginWhiteLists Adds cross-region log-in allowlists in batches 20
ModifyLoginWhiteInfo Updates the log-in audit allowlist information 20
DeleteLoginWhiteList Deletes the cross-region log-in allowlist rules 20
DescribeLoginWhiteHostList Queries the list of allowlisted machines after merge 20
ExportNonlocalLoginPlaces Exports cross-region log-in records 20
DescribeHostLoginList Retrieves log-in audit list 20
DescribeUsualLoginPlaces Queries common log-in locations 20

Password Cracking APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeBanMode Obtains brute-force blocking mode 20
ModifyBanMode Modifies the brute-force blocking mode 20
DescribeBanStatus Obtains the block button status 20
ModifyBanStatus Sets the block switch status 20
DescribeBanWhiteList Obtains the blocking allowlist list 20
DescribeBanRegions Obtains the block region 20
StopNoticeBanTips Stops displaying pop-up prompts about brute force cracking blocking 20
DeleteBruteAttacks Deletes brute force attack records 20
CreateBanWhiteList Adds the list of block allowlists. 20
DescribeBruteAttackRules Obtains brute force cracking rules 20
DeleteBanWhiteList Deletes the list of blocking allowlists 20
ModifyBruteAttackRules Modifies brute force cracking rules 20
ModifyBanWhiteList Modifies the blocking allowlist 20
ExportBruteAttacks Exports password cracking records 20
DescribeBruteAttackList Obtains the list of password cracking 20

Malicious Request APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeRiskDnsList Obtains the malicious request list 20
DeleteMaliciousRequests Deletes malicious request records 20
CreateMaliciousRequestWhiteList Adds malicious request allowlist 20
ModifyMaliciousRequestWhiteList Updates the malicious request allowlist 20
DeleteMaliciousRequestWhiteList Deletes malicious request allowlist 20
DescribeMaliciousRequestWhiteList Queries the list of malicious request allowlists 20
DeleteRiskDnsEvent Deletes malicious request events 20
DeleteRiskDnsPolicy Deletes malicious request policies 20
DescribeRiskDnsEventInfo Queries malicious request event details 20
DescribeRiskDnsEventList Obtains the list of malicious request events 20
DescribeRiskDnsPolicyList Obtains the list of malicious request policies 20
ExportRiskDnsPolicyList Exports the malicious request policy list 20
ModifyRiskDnsPolicy Modifies malicious request policies 20
ModifyRiskDnsPolicyStatus Modifies the status of malicious request policies 20
DescribeRiskDnsInfo Queries malicious request details 20
ExportMaliciousRequests Exports the downloaded malicious request files 20
ExportRiskDnsEventList Exports the malicious request event list 20

High-Risk Command APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeBashEvents Obtains the high-risk command list 20
DescribeBashEventsNew Obtains the list of high-risk commands (new) 20
SetBashEventsStatus Sets high-risk command event status 20
DeleteBashEvents Deletes high-risk command events 20
DescribeBashPolicies Obtains the list of high-risk command policies 20
DescribeBashRules Obtains the list of high-risk command rules 20
EditBashRules Adds or Modifies high-risk command rules (multiple servers supported) 20
ModifyBashPolicy Adds or Modifies high-risk command policies 20
DeleteBashPolicies Deletes high-risk command policies 20
DeleteBashRules Deletes high-risk command rules 20
ModifyBashPolicyStatus Switches the statuses of high-risk command policies 20
SwitchBashRules Switches the statuses of high-risk command rules 20
CheckBashPolicyParams Verifies parameters for high-risk commands added by the user 20
CheckBashRuleParams Verifies parameters for adding high-risk command user rules 20
DescribeBashEventsInfo High-risk command details 20
DescribeBashEventsInfoNew Obtains high-risk command details (new) 20
ExportBashEvents Exports high-risk command events 20
ExportBashEventsNew Exports high-risk command events (new) 20
ExportBashPolicies Exports the high-risk command policy 20

Local Privilege Escalation APIs

API Name Feature Frequency Limit (maximum requests per second)
DeletePrivilegeEvents Deletes local privilege escalation events 20
DescribePrivilegeRules Obtains the list of local privilege escalation rules 20
DeletePrivilegeRules Deletes local privilege elevation rules 20
EditPrivilegeRules Adds or Modifies local privilege elevation rules (multiple servers supported) 20
DescribePrivilegeEventInfo Queries local privilege escalation details 20
ExportPrivilegeEvents Exports local privilege escalation events 20

Reverse Shell APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeReverseShellEvents Obtains the list of Reverse Shell 20
DeleteReverseShellEvents Deletes Reverse Shell events 20
DescribeReverseShellRules Obtains the list of Reverse Shell rules 20
DeleteReverseShellRules Deletes Reverse Shell rules 20
EditReverseShellRules Edits reverse shell rules (multiple servers supported) 20
DescribeReverseShellEventInfo Queries reverse shell details 20
ExportReverseShellEvents Exports reverse shell events 20

Vulnerability Management APIs

API Name Feature Frequency Limit (maximum requests per second)
ScanVul Performs one-click vulnerability scans 20
DescribeScanSchedule Queries the detection progress 20
ScanVulAgain Redetects the API 20
DescribeVdbAndPocInfo Obtains virus database and POC updates 20
DescribeVulEmergentMsg Obtains vulnerability emergency notifications 20
DescribeVulTop Obtains statistics of top vulnerability 20
DescribeVulHostTop Obtains the list of top server risks 20
DescribeVulHostCountScanTime Obtains the number of vulnerabilities pending to be processed and affected hosts 20
DescribeUndoVulCounts Obtains the number of vulnerabilities of a specified category 20
DescribeVulCountByDates Obtains the number of vulnerabilities of specified types in recent days and the number of hosts 20
DescribeVulLevelCount Queries the statistics of vulnerability quantity and level distribution 20
ExportVulList Exports the vulnerability list 15
CreateEmergencyVulScan Creates emergency vulnerability scan tasks 20
DescribeVulCveIdInfo Queries vulnerability details by CveId 20
DescribeVulInfoCvss Vulnerability details 20
DescribeVulEffectHostList Obtains the list of hosts affected by vulnerabilities 10
DescribeVulEffectModules List of components affected by vulnerabilities 20
ExportVulEffectHostList Exports the list of hosts affected by vulnerabilities 20
ExportVulInfo Exports the vulnerability information 20
IgnoreImpactedHosts Ignores vulnerabilities 20
CancelIgnoreVul Unignores the vulnerabilities 20
ExportVulDetectionReport Exports the vulnerability detection report 20
ModifyVulDefenceSetting Modifies vulnerability defense plugin settings 20
ExportVulDefencePluginEvent Exports vulnerability defense plugin events 20
DescribeVulDefencePluginDetail Obtain the vulnerability defense plugin information on a single host 20
DescribeVulDefenceEvent Obtains the list of vulnerability defense events 20
ExportVulDefenceEvent Exports vulnerability defense events 20
ModifyVulDefenceEventStatus Changes the vulnerability defense event status 20
DescribeDefenceEventDetail Obtains vulnerability defense event details 20
CreateVulFix Submits the vulnerabilities and fixes them 20
DescribeCanFixVulMachine Queries the fixable host information 20
DescribeMachineSnapshot Query recent snapshots created by the host 20
DescribeVulDefenceList Queries the vulnerability defense list 20
DescribeVulFixStatus Checks the host vulnerability fixing progress 20
ExportVulDefenceList Exports the list of vulnerability defenses 20
RetryCreateSnapshot Retries to create snapshots 20
RetryVulFix Retries to fix vulnerabilities 20
DescribeScanVulSetting Queries the configuration for regular detection 20
ScanVulSetting Completes regular vulnerability scan settings 20
DescribeEmergencyVulList List of emergency vulnerabilities 20
DescribeVulDefencePluginStatus Obtains the vulnerability defense plugin status of each host 20
ExportVulDetectionExcel Exports the vulnerability detection Excel document. 20
DescribeVulList List of vulnerabilities 20

New Baseline Management APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteBaselinePolicy Deletes the baseline policy configuration 20
DescribeBaselineHostDetectList Obtains the list of hosts for baseline detection 20
DescribeBaselineItemDetectList Obtains the list of baseline detection items 20
DescribeBaselineItemList Obtains the list of check results on baseline check items 20
DescribeBaselinePolicyList Obtains the list of baseline policies 20
DescribeBaselineWeakPasswordList Obtains the list of baseline weak passwords 20
DescribeIgnoreHostAndItemConfig Obtains the information of affected inspection items and hosts ignored with one click. 20
ExportBaselineFixList Exports the list of fixing baselines 20
ExportBaselineHostDetectList Exports the baseline for host detection 20
ExportBaselineItemDetectList Exports baseline check items 20
StartBaselineDetect Performs baseline checks 20
StopBaselineDetect Stops baseline check 20
SyncBaselineDetectSummary Syncs the summary of baseline detection progress 20
DescribeHotVulTop Obtains hot spot vulnerabilities across the entire network 20
DescribeVulStoreList Obtains the vulnerability database list 20
ModifyBaselinePolicy Modifies or adds baseline policy settings 20

Baseline Management APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeBaselineTop TOP baseline detection items 20
DescribeBaselineHostTop Top N server risk APIs 20
DescribeBaselineDefaultStrategyList Queries the list information of default policies of the baseline 20
CreateBaselineStrategy Creates a baseline policy 20
DescribeStrategyExist Queries whether a policy exists by policy name 20
UpdateBaselineStrategy Updates the baseline policy information 20
DeleteBaselineStrategy Deletes the baseline policy 20
DescribeBaselineStrategyList Queries the list of a user's baseline policies 20
DescribeBaselineStrategyDetail Queries baseline policy details 20
DescribeBaselineBasicInfo Queries the basic information of the baseline 20
DescribeBaselineEffectHostList List of hosts affected by a baseline 20
DescribeBaselineList Queries the baseline list 20
DescribeBaselineDetail Queries baseline details 20
ScanBaseline Baseline detection APIs 20
DescribeBaselineScanSchedule Queries the baseline detection progress 20
CheckFirstScanBaseline Queries whether the baseline is detected for the first time 20
ChangeStrategyEnableStatus Changes policy availability status 20
ChangeRuleEventsIgnoreStatus Changes the event ignoring status 20
DescribeIgnoreBaselineRule Queries the information of ignored inspection items 20
DescribeIgnoreRuleEffectHostList Queries the list of hosts affected by ignored detection items 20
DescribeBaselineRule Queries the baseline check item information 20
ExportBaselineEffectHostList Exports the list of hosts affected by baseline 20
ExportBaselineList Exports the baseline list 20
ExportIgnoreBaselineRule Exports ignored baseline detection items 20
ExportIgnoreRuleEffectHostList Exports the list of hosts affected by ignored detection items 20

Advanced Defense APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeAttackEvents List of network attack detection events 20
DescribeAttackLogs List of network attack logs (Discarded. Use DescribeAttackEvents instead.) 20
DescribeMachineDefenseCnt Queries the statistics of advanced defense events for hosts 20
DescribeMachineRiskCnt Queries the statistics of host intrusion detection events 20
ExportFileTamperEvents Exports core file events 20
DescribeAttackVulTypeList Obtains the list of network attack threat types 20
DescribeVulLabels Obtains the vulnerability tag list 20
DescribeVulOverview Obtains the data of vulnerability overview 20
CheckFileTamperRule Checks the rule parameters entered at the core file monitoring frontend 20
DescribeRansomDefenseBackupList Queries the list of host snapshot backups 20
DescribeRansomDefenseEventsList Queries the anti-ransomware event list 20
DescribeRansomDefenseMachineList Queries the list of backup details 20
DescribeRansomDefenseRollBackTaskList Queries the rollback task list 20
DescribeRansomDefenseStrategyMachines Queries the list of machines bound to an anti-ransomware policy 20
ModifyWebPageProtectSwitch Enables or disables website protection 20
ModifyFileTamperEvents Updates the core file events 20
ModifyFileTamperRuleStatus Updates the core file rule status 20
DescribeFileTamperEventRuleInfo Views the rule details API when an event occurs 20
DescribeFileTamperRuleCount Queries the number of rules for monitoring files associated with a host 20
DescribeFileTamperRuleInfo Queries details of a file monitoring rule 20
ModifyRansomDefenseEventsStatus Modifies the status of anti-ransomware events 20
DescribeFileTamperEvents Obtains the list of core file monitoring events 20
DescribeRansomDefenseStrategyList Queries the list of anti-ransomware policies 20
ExportRansomDefenseBackupList Exports the list of host snapshot backups 20
ExportRansomDefenseEventsList Exports the list of anti-ransomware events 20
ExportRansomDefenseMachineList Exports the backup details list 20
ExportRansomDefenseStrategyList Exports the anti-ransomware policy list 20
ExportRansomDefenseStrategyMachines Exports the list of machines bound to ransomware defense policies 20
ModifyFileTamperRule Edits core file monitoring rules 20
ExportFileTamperRules Exports core file monitoring rules 20
ModifyNetAttackSetting Modifies network attack settings 20
DescribeAttackEventInfo Obtains network attack details 20
DescribeAttackStatistics Network attack data statistics 20
DescribeAttackTop List of Top network attacks 20
DescribeAttackTrends Obtains the network attack trend data 20
DescribeNetAttackSetting Queries network attack settings 20
ExportAttackEvents Exports network attack events 20
CreateRansomDefenseStrategy Creates or modifies anti-ransomware policies 20

Security Operation APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeHistoryService Queries the log retrieval service information 20
DescribeLogStorageStatistic Obtains the statistics of the used log retrieval capacity. 20
DescribeSearchLogs Obtains historical search records 20
CreateSearchLog Adds history search records 20
DescribeSearchTemplates Obtains the list of quick retrievals 20
CreateSearchTemplate Adds the retrieval template 20
DeleteSearchTemplate Deletes the retrieval template 20
DescribeIndexList Obtains the index list 20
DescribeESAggregations Obtains the aggregation result of the ES field 20
DescribeLogType Obtains log types 20

Expert Service APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeAvailableExpertServiceDetail Available order details 20
DescribeExpertServiceOrderList Obtains the expert service order list 20
DescribeExpertServiceList Obtains the security manager list 20
DescribeMonthInspectionReport Downloads the monthly inspection report of the security manager 20
DescribeEmergencyResponseList Obtains the emergency response list 20

Other APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeSecurityBroadcastInfo Queries the information of security report articles 20
DescribeLogStorageConfig Obtains the log storage configuration 20
DescribeLogStorageRecord Obtains the record of stored log size 20
ModifyLogStorageConfig Modifies the log storage configuration 20
DescribeTrialReport Queries the trial report 20
DescribeAssetEnvList Queries the list of asset management environment variables 20
DescribeABTestConfig Obtains the current grayscale configuration of the user 20
DescribeRiskBatchStatus Queries whether the intrusion detection event update task is completed 20
ExportTasks Exports tasks asynchronously 20
DescribeGeneralStat Obtains the statistics data of hosts. 20
DescribeScreenGeneralStat Obtains the visualized statistics data of hosts on the screen 20
DescribeVersionStatistics Obtains the number of machines of Professional and Basic editions 20
DescribeProVersionInfo Obtains the overview information of the Professional edition 20
DescribeSafeInfo Queries the security notification 20
DescribeOverviewStatistics Obtains the overview statistics 20
DescribeSecurityDynamics Obtains the dynamic message of security events 20
DescribeRansomDefenseMachineStrategyInfo Obtains the list of policies bound to a host 20
DescribeRansomDefenseState Obtain user anti-ransomware trends 20
DescribeRansomDefenseStrategyDetail Obtains the policy details 20
DescribeRansomDefenseTrend Obtains the ransomware situation across the entire network 20
DescribeSecurityEventStat Obtains the statistics of security events 20
ModifyRansomDefenseStrategyStatus Modifies the anti-ransomware policy status in batches 20
RansomDefenseRollback Rolls back anti-ransomware snapshots 20
DescribeScreenAttackHotspot Obtains the attacked hot spots across the entire network through the large screen visualization 20
DescribeScreenBroadcasts Obtains the security report on the large screen 20
DescribeScreenDefenseTrends Obtains attack and defense trends on the large screen 20
DescribeScreenEmergentMsg Obtains the visualized emergency notification on the large screen 20
DescribeScreenEventsCnt Obtains the screen security event statistics data 20
DescribeScreenHostInvasion Obtains the visualized host intrusion details on the large screen 20
DescribeScreenMachineRegions Obtains the list of available visualized host regions on the large screen 20
DescribeScreenMachines Obtains the visualized list of hosts on the large screen. 20
DescribeScreenProtectionCnt Visualized introduction of CWPP engine on the large screen 20
DescribeScreenRiskAssetsTop Top 5 risky assets (by today) on the large screen 20
DescribeSecurityEventsCnt Obtains the statistics data of security events 20
DescribeSecurityTrends Obtains the security event statistics data 20
ExportSecurityTrends Exports risk trends 20
DescribeScanTaskDetails Queries the scan task details 20
DescribeScanState Queries the scan status 20
DeleteScanTask Stops scan tasks 20
DescribeScanTaskStatus Queries the list of machine scan statuses 20
ScanTaskAgain Restarts the scan task 20
DescribeAgentInstallCommand Obtains the agent installation command 20
DescribePublicProxyInstallCommand Obtains the installation command of the public network access proxy 20
DescribeVersionCompareChart Obtains the version comparison information 20
CreateBuyBindTask Create a binding task for newly purchased authorizations 20
SyncMachines Syncs the machine information 20
CheckLogKafkaConnectionState Checks the connectivity for log shipping from Kafka 20
CreateLogExport Creates log download tasks 20
DeleteLogExport Deletes log download tasks 20
DescribeAESKey Obtains the configured aeskey and aesiv 20
DescribeAssetTypes Obtains the asset fingerprint type list 20
DescribeAttackSource Backtrack attacks 20
DescribeAttackSourceEvents Queries attack backtracking events 20
DescribeCanNotSeparateMachine Obtains hosts where Trojans cannot be isolated 20
DescribeClientException Obtain client exception events 20
DescribeFastAnalysis Quick analysis and statistics of logs 20
DescribeLogDeliveryKafkaOptions Queries the list of logs available for shipping to Kafka. 20
DescribeLogExports Obtains the list of log download tasks 20
DescribeLogHistogram Obtains the log histogram information 20
DescribeLogIndex Queries the index 20
DescribeLogKafkaDeliverInfo Obtains information of Kafka shipping 20
DescribeScreenProtectionStat Obtains the security protection status on the large screen 20
DescribeWarningHostConfig Queries the alarming machine scope settings 20
ModifyLogKafkaAccess Adds or modifies the access configuration of logs shipped to Kafka 20
ModifyLogKafkaDeliverType Modifies the shipping configuration and switch of the specified log category 20
ModifyLogKafkaState Modifies the information of log shipping statuses 20
ModifyEventAttackStatus Modifies the status of network attack events 20
ModifyRiskEventsStatus Changes the status of intrusion detection events 20
ModifyWarningHostConfig Modifies the alarming machine scope settings 20
SearchLog Queries logs 20
StopAssetScan Stops the asset scan task 20
ClearLocalStorage Cleans up the locally stored data 20
DescribeLicenseWhiteConfig Queries the configurations for authorization allowlists 20
DescribeProductStatus Queries the product trial status 20
GetLocalStorageItem Obtains the locally stored data 20
KeysLocalStorage Obtains the list of locally stored key values 20
RemoveLocalStorageItem Deletes the locally stored data 20
SetLocalStorageExpire Sets the expiration time of the locally stored data 20
SetLocalStorageItem Sets the locally stored data 20
DescribeVulTrend Obtain information of the vulnerability situation 20
ExportScanTaskDetails Exports scan task details 20
DescribeAlarmIncidentNodes Obtains all node information on the event corresponding to an alarm 20
DescribeAlarmVertexId Queries the list of alarm IDs 20
DescribeEventByTable Queries alarm event details based on event table names and IDs 20
DescribeProVersionStatus Obtains the status of Professional edition 20
DescribeVertexDetail Obtains the attribute information of the specified point. 20
DeleteWebHookPolicy Deletes alarm policies 20
DeleteWebHookReceiver Deletes the alert recipient 20
DescribeRecommendedProtectCpu Queries the recommended number of protection cores for purchase 20
DescribeUsersConfig Queries the user's configuration 20
DescribeWebHookPolicy Queries alarm policies 20
DescribeWebHookReceiver Queries the list of alarm recipients 20
DescribeWebHookReceiverUsage Queries the usage of policies associated with the specified alarm recipient 20
ModifyUsersConfig Modifies user settings 20
ModifyWebHookPolicy Adds or modifies alarm policies. 20
ModifyWebHookPolicyStatus Modifies the alarm policy switch 20
ModifyWebHookReceiver Adds or updates the alarm recipient 20

Overview Statistics APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeSecurityProtectionStat Obtains the status of security protection 20
DescribeSecurityBroadcasts Security report list 20

Settings Center APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeWarningList Obtains the list of the current user's alarms 20
ModifyWarningSetting Modifies alarm settings 20
ModifyAutoOpenProVersionConfig Sets the configuration of automatic enabling 20
DescribeLicenseGeneral Obtains the authorization overview information 20
DescribeLicenseList Obtains the authorization order list 20
DeleteLicenseRecord Deletes authorization records 20
DescribeLicenseBindList Views the list of hosts bound to the authorization 20
ModifyLicenseBinds Binds machines to an authorization in batches 20
DescribeLicenseBindSchedule Queries the binding progress of the authorization 20
CreateLicenseOrder Creates authorization orders 20
DeleteLicenseRecordAll Deletes all authorization records 20
DestroyOrder Terminates orders 20
CreateWhiteListOrder Creates allowlist orders 20
DeleteWebHookRule Deletes the rules of WeCom chatbots 20
DescribeLicense Queries the authorization information 20
DescribeWebHookRule Obtains the details of the WeCom chatbot rules 20
DescribeWebHookRules Obtains the list of WeCom chatbot rules 20
ExportLicenseDetail Exports authorization details 20
ModifyWebHookRule Adds or modifies the rules of WeCom chatbots 20
ModifyWebHookRuleStatus Modifies the rules of WeCom chatbots. 20
TestWebHookRule Tests the rules of WeCom chatbots 20
ModifyLicenseOrder Edits authorization orders 20

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan