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 Instance 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
Parameter Template 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
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
Page Performance APIs
Custom Speed Test APIs
Custom Event APIs
Monitoring APIs
Exception Analysis APIs
Page Visit 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
文档APIsTencentDB for PostgreSQLData Types

Data Types

聚焦模式
字号
最后更新时间： 2026-04-01 18:23:16

AccountInfo

Account information

Used by actions: DescribeAccounts.

Name Type Description
DBInstanceId String Instance ID in the format of postgres-lnp6j617
UserName String Account
Remark String Account remarks
Status Integer Account status. 1: creating, 2: normal, 3: modifying, 4: resetting password, -1: deleting
CreateTime Timestamp Account creation time
UpdateTime Timestamp Account last modified time

AnalysisItems

Detailed analysis of a slow query statement with abstract parameter values, which is returned by the DescribeSlowQueryAnalysis API

Used by actions: DescribeSlowQueryAnalysis.

Name Type Description
DatabaseName String The name of the database queried by the slow query statement
UserName String The name of the user who executes the slow query statement
NormalQuery String The slow query statement whose parameter values are abstracted
ClientAddr String The address of the client that executes the slow query statement
CallNum Integer The number of executions of the slow query statement during the specified period of time
CallPercent Float The ratio (in decimal form) of the number of executions of the slow query statement to that of all slow query statements during the specified period of time
CostTime Float The total execution time of the slow query statement during the specified period of time
CostPercent Float The ratio (in decimal form) of the total execution time of the slow query statement to that of all slow query statements during the specified period of time
MinCostTime Float The shortest execution time (in ms) of the slow query statement during the specified period of time
MaxCostTime Float The longest execution time (in ms) of the slow query statement during the specified period of time
AvgCostTime Float The average execution time (in ms) of the slow query statement during the specified period of time
FirstTime String The timestamp when the slow query statement starts to execute for the first time during the specified period of time
LastTime String The timestamp when the slow query statement starts to execute for the last time during the specified period of time

BackupDownloadRestriction

Restriction information for downloading a backup

Used by actions: DescribeBackupDownloadURL.

Name Type Required Description
RestrictionType String No Type of the network restrictions for downloading backup files. Valid values: NONE (backups can be downloaded over both private and public networks), INTRANET (backups can only be downloaded over the private network), CUSTOMIZE (backups can be downloaded over specified VPCs or at specified IPs).
VpcRestrictionEffect String No Whether VPC is allowed. Valid values: ALLOW (allow), DENY (deny).
VpcIdSet Array of String No Whether it is allowed to download the VPC ID list of the backup files.
IpRestrictionEffect String No Whether IP is allowed. Valid values: ALLOW (allow), DENY (deny).
IpSet Array of String No Whether it is allowed to download IP list of the backup files.

BackupPlan

Backup plan

Used by actions: DescribeBackupPlans.

Name Type Description
BackupPeriod String Backup cycle
BaseBackupRetentionPeriod Integer Data backup retention duration
MinBackupStartTime String The earliest time to start a backup
MaxBackupStartTime String The latest time to start a backup

BackupSummary

Instance backup statistics

Used by actions: DescribeBackupSummaries.

Name Type Description
DBInstanceId String Instance ID
LogBackupCount Integer Number of log backups of an instance
LogBackupSize Integer Size of log backups of an instance
ManualBaseBackupCount Integer Number of manually created instance data backups.
ManualBaseBackupSize Integer Size of manually created instance data backups.
AutoBaseBackupCount Integer Number of automatically created instance data backups.
AutoBaseBackupSize Integer Size of automatically created instance data backups.
TotalBackupCount Integer Total number of backups
TotalBackupSize Integer Total backup size

BaseBackup

Database data backup information

Used by actions: DescribeBaseBackups.

Name Type Description
DBInstanceId String Instance ID
Id String Unique ID of a backup file
Name String Backup file name.
BackupMethod String Backup method, including physical and logical.
BackupMode String Backup mode, including automatic and manual.
State String Backup task status
Size Integer Backup set size in bytes
StartTime String Backup start time
FinishTime String Backup end time
ExpireTime String Backup expiration time

ClassInfo

Database instance specification

Used by actions: DescribeClasses.

Name Type Description
SpecCode String Specification ID
CPU Integer Number of CPU cores
Memory Integer Memory size in MB
MaxStorage Integer Maximum storage capacity in GB supported by this specification
MinStorage Integer Minimum storage capacity in GB supported by this specification
QPS Integer Estimated QPS for this specification

DBBackup

Database backup information

Used by actions: DescribeDBBackups.

Name Type Description
Id Integer Unique backup file ID
StartTime String File generation start time
EndTime String File generation end time
Size Integer File size in KB
Strategy Integer Policy (0: instance backup, 1: multi-database backup)
Way Integer Type (0: scheduled)
Type Integer Backup mode (1: full)
Status Integer Status (1: creating, 2: success, 3: failure)
DbList Array of String DB list
InternalAddr String Download address on private network
ExternalAddr String Download address on public network
SetId String Backup set ID
Note: this field may return null, indicating that no valid values can be obtained.

DBInstance

Instance details

Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

Name Type Description
Region String

Region of the instance, for example: ap-guangzhou, corresponds to the region field in RegionSet.
Zone String

Availability zone to which the instance belongs, for example: ap-guangzhou-3, corresponds to the Zone field in ZoneSet.
VpcId String

VPC ID, such as vpc-e6w23k31. A valid VPC ID can be obtained by logging in to the console to query or by calling the API DescribeVpcs and acquiring the unVpcId field in API return.
SubnetId String

VPC subnet ID, such as subnet-51lcif9y. An effective VPC subnet ID can be obtained by logging in to the console to query. You can also call API DescribeSubnets and get it from the unSubnetId field in API return.
DBInstanceId String

Instance ID.
DBInstanceName String

Instance name.
DBInstanceStatus String

Instance status, including: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (restricted operation), isolating (isolating), isolated (isolated), disisolating (de-isolating), recycling (recycling), recycled (recycled), job running (task executing), offline (offline), migrating (migrating), expanding (scaling out), waitSwitch (waiting to switch), switching (switching), readonly (readonly), restarting (restarting), network changing (network modification in progress), upgrading (kernel version upgrading), audit-switching (audit status changing), primary-switching (primary-secondary switching), offlining (offline), deployment changing (modify AZ), cloning (recovering data), parameter modifying (parameter modification in progress), log-switching (log status change), restoring (recovering), and expanding (scaling out)
DBInstanceMemory Integer

Memory size allocated to the instance, measurement unit: GB
DBInstanceStorage Integer

Storage space size allocated to the instance, measurement unit: GB
DBInstanceCpu Integer

Number of CPUs allocated to the instance, unit: piece
DBInstanceClass String

Purchasable specification ID.
DBMajorVersion String

PostgreSQL major version number. Version information can be obtained from DescribeDBVersions. Currently supports major versions 10, 11, 12, 13, 14, and 15.
DBVersion String

PostgreSQL community major version + minor version number, such as 12.4. Version information can be obtained from DescribeDBVersions.
DBKernelVersion String

PostgreSQL Kernel Version, for example v12.7_r1.8. Version information can be obtained from DescribeDBVersions.
DBInstanceType String

Instance types:

  • primary: Primary instance
  • readonly: Read-only instance
  • guard: Disaster recovery instance
  • temp: Temporary instance
    		•
    DBInstanceVersion String

    Instance version currently only supports standard (dual-server high-availability edition, one master and one slave).
    DBCharset String

    Instance character set, which currently supports only:

  • UTF8
  • LATIN1
    		•
    CreateTime Timestamp

    Instance creation time.
    UpdateTime Timestamp

    The time when the instance executed the last update.
    ExpireTime Timestamp

    Instance expiration time.
    IsolatedTime Timestamp

    Instance isolation time.
    PayType String

    Billing mode:

  • prepaid: Yearly/monthly subscription, prepayment
  • postpaid: Pay-as-you-go, postpaid
    		•
    AutoRenew Integer

    Auto-renewal or not:

  • 0: Manual renewal
  • 1: Auto renewal
    • Default value: 0
    DBInstanceNetInfo Array of DBInstanceNetInfo

    Instance network connection information.
    Type String

    Machine type.
    AppId Integer

    User's app id.
    Uid Integer

    Uid of the instance.
    ProjectId Integer

    Project ID.
    TagList Array of Tag

    Tag information associated with the instance.
    MasterDBInstanceId String

    Primary instance information. Returned only when the instance is a read-only instance.
    ReadOnlyInstanceNum Integer

    Number of read-only instances.
    StatusInReadonlyGroup String

    State of the read-only instance in the read-only group.
    OfflineTime String

    Offline time.
    DBNodeSet Array of DBNode

    Instance node information.


    Note: This field may return null, indicating that no valid values can be obtained.
    IsSupportTDE Integer

    Whether the instance supports TDE data encryption:

  • 0: Not supported
  • 1: Supported
    • Default value: 0. For TDE data encryption, see Overview of Data Transparent Encryption.
    DBEngine String

    Database engine, support:

  • postgresql: TencentDB for PostgreSQL
  • mssql_compatible: MSSQL compatible - TencentDB for PostgreSQL
    • Default value: postgresql
    DBEngineConfig String

    Configuration information for the database engine. The configuration format is as follows:
    {"$key1":"$value1", "$key2":"$value2"}
    Supported engines:
    mssql_compatible engine:

  • migrationMode: Database schema, optional parameter. Valid values: single-db (single-database mode), multi-db (multi-database mode). Default is single-db.
  • defaultLocale: Sorting area rule, optional parameter, cannot be modified after initialization. Default is en_US. Valid values include: "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN".
  • serverCollationName: Collation name, optional parameter, cannot be modified after initialization. Default is sql_latin1_general_cp1_ci_as. Valid values include: "bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as".
    		•
    NetworkAccessList Array of NetworkAccess

    Instance network information list (deprecated)


    Note: This field may return null, indicating that no valid values can be obtained.
    SupportIpv6 Integer

    Whether the instance supports Ipv6:

  • 0: No
  • 1: Yes
    • Default value: 0
    ExpandedCpu Integer

    Number of cpu cores that have been elastically scaled out for the instance
    DeletionProtection Boolean

    Whether to enable deletion protection for the instance, values as follows:

    • true: enable deletion protection
    • false: disable deletion protection
    DBInstanceStorageType String

    Instance storage type. Available values: PHYSICAL_LOCAL_SSD: LOCAL SSD hard disk of PHYSICAL machine; CLOUD_PREMIUM: high-performance CLOUD block storage; CLOUD_SSD: SSD CLOUD disk; CLOUD_HSSD: enhanced SSD CLOUD disk.

    DBInstanceNetInfo

    Instance network connection information

    Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

    Name Type Description
    Address String DNS domain name
    Ip String Ip
    Port Integer Connection port address
    NetType String Network type. 1: inner (private network address), 2: public (public network address)
    Status String Network connection status. Valid values: initing (never enabled before), opened (enabled), closed (disabled), opening (enabling), closing (disabling)
    VpcId String VPC ID. specifies the ID of the virtual private cloud.
    SubnetId String Subnet ID.
    ProtocolType String Specifies the protocol type to connect to the database. currently supported: postgresql, mssql (mssql compatible syntax).

    DBNode

    Describes the instance node information, including the node type, availability zone where the node is located, and dedicated cluster where the node resides.

    Used by actions: CloneDBInstance, CreateInstances, DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups, ModifyDBInstanceDeployment.

    Name Type Required Description
    Role String Yes Node type. Valid values:
    Primary;
    Standby.
    Zone String Yes AZ where the node resides, such as ap-guangzhou-1.
    DedicatedClusterId String No CDC ID.

    Detail

    Details returned by the DescribeSlowQueryAnalysis API

    Used by actions: DescribeSlowQueryAnalysis.

    Name Type Description
    TotalTime Float The total execution time (in ms) of all slow query statements during the specified period of time
    TotalCallNum Integer The total number of all slow query statements during the specified period of time
    AnalysisItems Array of AnalysisItems The statistical analysis list of slow queries
    Note: this field may return null, indicating that no valid values can be obtained.

    DurationAnalysis

    Analyze the execution time of slow query statements by classifying them to different time ranges

    Used by actions: DescribeSlowQueryList.

    Name Type Description
    TimeSegment String Time range
    Count Integer The number of slow query statements whose execution time falls within the time range

    EncryptionKey

    KMS key information

    Used by actions: DescribeEncryptionKeys.

    Name Type Description
    KeyId String Encrypted KeyId of KMS instance
    Note: This field may return null, indicating that no valid value can be obtained.
    KeyAlias String Encryption key alias of KMS instance
    Note: This field may return null, indicating that no valid value can be obtained.
    DEKCipherTextBlob String Instance DEK ciphertext
    Note: This field may return null, indicating that no valid value can be obtained.
    IsEnabled Integer Whether the key is enabled. Valid values: 1 (yes), 0 (no)
    Note: This field may return null, indicating that no valid value can be obtained.
    KeyRegion String Region where KMS key resides
    Note: This field may return null, indicating that no valid value can be obtained.
    CreateTime String DEK key creation time
    Note: This field may return null, indicating that no valid value can be obtained.

    ErrLogDetail

    Error log details

    Used by actions: DescribeDBErrlogs.

    Name Type Description
    UserName String Username
    Database String Database name
    ErrTime String Error occurrence time
    ErrMsg String Error message

    EventInfo

    Parameter modification event information

    Used by actions: DescribeParamsEvent.

    Name Type Description
    ParamName String Parameter name
    Note: this field may return null, indicating that no valid values can be obtained.
    OldValue String Original parameter value
    Note: this field may return null, indicating that no valid values can be obtained.
    NewValue String New parameter value in this modification event
    Note: this field may return null, indicating that no valid values can be obtained.
    ModifyTime String Start time of parameter modification
    Note: this field may return null, indicating that no valid values can be obtained.
    EffectiveTime String Start time when the modified parameter takes effect
    Note: this field may return null, indicating that no valid values can be obtained.
    State String Modification status
    Note: this field may return null, indicating that no valid values can be obtained.
    Operator String Operator (generally, the value is the UIN of a sub-user)
    Note: this field may return null, indicating that no valid values can be obtained.
    EventLog String Event log
    Note: this field may return null, indicating that no valid values can be obtained.

    EventItem

    Modification details of one parameter

    Used by actions: DescribeParamsEvent.

    Name Type Description
    ParamName String Parameter name
    Note: this field may return null, indicating that no valid values can be obtained.
    EventCount Integer The number of modification events
    Note: this field may return null, indicating that no valid values can be obtained.
    EventDetail Array of EventInfo Modification event details
    Note: this field may return null, indicating that no valid values can be obtained.

    Filter

    Key-value pair filter for conditional filtering queries, such as filter ID and name

    • If more than one filter exists, the logical relationship between these filters is AND.
    • If multiple values exist in one filter, the logical relationship between these values is OR.

    Used by actions: DescribeBackupSummaries, DescribeBaseBackups, DescribeDBInstances, DescribeDatabases, DescribeLogBackups, DescribeParameterTemplates, DescribeReadOnlyGroups, DescribeServerlessDBInstances.

    Name Type Required Description
    Name String No Filter name.
    Values Array of String No One or more filter values.

    LogBackup

    Log backup information of a database

    Used by actions: DescribeLogBackups.

    Name Type Description
    DBInstanceId String Instance ID
    Id String Unique ID of a backup file
    Name String Backup file name
    BackupMethod String Backup method, including physical and logical.
    BackupMode String Backup mode, including automatic and manual.
    State String Backup task status
    Size Integer Backup set size in bytes
    StartTime String Backup start time
    FinishTime String Backup end time
    ExpireTime String Backup expiration time

    NetworkAccess

    Network information. (This parameter structure has been deprecated. Please use DBInstanceNetInfo to query network information.)

    Used by actions: DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups.

    Name Type Description
    ResourceId String Network resource id, instance id, or RO group id.
    ResourceType Integer Resource type. valid values: 1 (instance), 2 (RO group).
    VpcId String VPC ID. specifies the ID of the virtual private cloud.
    Vip String IPv4 Address
    Vip6 String IPv6 Address
    Vport Integer Specifies the access port.
    SubnetId String Subnet ID.
    VpcStatus Integer Network status. valid values: 1-applying, 2-active, 3-deleting, 4-deleted.

    NormalQueryItem

    Information of one SlowQuery

    Used by actions: DescribeDBSlowlogs.

    Name Type Description
    UserName String Username
    Calls Integer Number of calls
    CallsGrids Array of Integer Granularity
    CostTime Float Total time consumed
    Rows Integer Number of affected rows
    MinCostTime Float Minimum time consumed
    MaxCostTime Float Maximum time consumed
    FirstTime String Time of the earliest slow SQL statement
    LastTime String Time of the latest slow SQL statement
    SharedReadBlks Integer Shared memory blocks for reads
    SharedWriteBlks Integer Shared memory blocks for writes
    ReadCostTime Integer Total IO read time
    WriteCostTime Integer Total IO write time
    DatabaseName String Database name
    NormalQuery String Slow SQL statement after desensitization

    ParamEntry

    Parameters to be modified in batches

    Used by actions: ModifyDBInstanceParameters, ModifyParameterTemplate.

    Name Type Required Description
    Name String Yes Parameter name
    ExpectedValue String Yes The new value to which the parameter will be modified. When this parameter is used as an input parameter, its value must be a string, such as 0.1 (decimal), 1000 (integer), and replica (enum).

    ParamInfo

    Parameter details

    Used by actions: DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes.

    Name Type Description
    ID Integer Parameter ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Name String Parameter name
    Note: this field may return null, indicating that no valid values can be obtained.
    ParamValueType String Value type of the parameter. Valid values: integer, real (floating-point), bool, enum, mutil_enum (this type of parameter can be set to multiple enumerated values).
    For an integer or real parameter, the Min field represents the minimum value and the Max field the maximum value.
    For a bool parameter, the valid values include true and false;
    For an enum or mutil_enum parameter, the EnumValue field represents the valid values.
    Note: this field may return null, indicating that no valid values can be obtained.
    Unit String Unit of the parameter value. If the parameter has no unit, this field will return null.
    Note: This field may return null, indicating that no valid values can be obtained.
    DefaultValue String Default value of the parameter, which is returned as a string
    Note: this field may return null, indicating that no valid values can be obtained.
    CurrentValue String Current value of the parameter, which is returned as a string
    Note: this field may return null, indicating that no valid values can be obtained.
    Max Float The maximum value of the integer or real parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    EnumValue Array of String Value range of the enum parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    Min Float The minimum value of the integer or real parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    ParamDescriptionCH String Parameter description in Chinese
    Note: this field may return null, indicating that no valid values can be obtained.
    ParamDescriptionEN String Parameter description in English
    Note: this field may return null, indicating that no valid values can be obtained.
    NeedReboot Boolean Whether to restart the instance for the modified parameter to take effect. Valid values: true (yes), false (no)
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassificationCN String Parameter category in Chinese
    Note: this field may return null, indicating that no valid values can be obtained.
    ClassificationEN String Parameter category in English
    Note: this field may return null, indicating that no valid values can be obtained.
    SpecRelated Boolean Whether the parameter is related to specifications. Valid values: true (yes), false (no)
    Note: this field may return null, indicating that no valid values can be obtained.
    Advanced Boolean Whether it is a key parameter. Valid values: true (yes, and modifying it may affect instance performance), false (no)
    Note: this field may return null, indicating that no valid values can be obtained.
    LastModifyTime String The last modified time of the parameter
    Note: this field may return null, indicating that no valid values can be obtained.
    StandbyRelated Integer Parameter primary-secondary constraints, 0: No constraint, 1: Standby parameter value must be greater than that of the primary machine, 2: Primary parameter value must be greater than that of the standby machine.
    Note: This field may return null, indicating that no valid values can be obtained.
    VersionRelationSet Array of ParamVersionRelation Parameter version association information, containing detailed parameter information for the respective kernel version
    Note: This field may return null, indicating that no valid values can be obtained.
    SpecRelationSet Array of ParamSpecRelation Parameter specification association information, containing detailed parameter information for the respective specification
    Note: This field may return null, indicating that no valid values can be obtained.

    ParamSpecRelation

    Parameter information for each specification

    Used by actions: DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes.

    Name Type Description
    Name String Parameter name
    Note: This field may return null, indicating that no valid values can be obtained.
    Memory String The specification that corresponds to the parameter information
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String The default parameter value under this specification
    Note: This field may return null, indicating that no valid values can be obtained.
    Unit String Unit of the parameter value. If the parameter has no unit, this field will return null.
    Note: This field may return null, indicating that no valid values can be obtained.
    Max Float The maximum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    Min Float The minimum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    EnumValue Array of String Value range of the enum parameter
    Note: This field may return null, indicating that no valid values can be obtained.

    ParamVersionRelation

    Parameter information for each version

    Used by actions: DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes.

    Name Type Description
    Name String Parameter name
    Note: This field may return null, indicating that no valid values can be obtained.
    DBKernelVersion String The kernel version that corresponds to the parameter information
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String Default parameter value under the kernel version and specification of the instance
    Note: This field may return null, indicating that no valid values can be obtained.
    Unit String Unit of the parameter value. If the parameter has no unit, this field will return null.
    Note: This field may return null, indicating that no valid values can be obtained.
    Max Float The maximum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    Min Float The minimum value of the integer or real parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    EnumValue Array of String Value range of the enum parameter
    Note: This field may return null, indicating that no valid values can be obtained.

    ParameterTemplate

    Basic information of a parameter template

    Used by actions: DescribeParameterTemplates.

    Name Type Description
    TemplateId String Parameter template ID
    TemplateName String Parameter template name
    DBMajorVersion String Database version applicable to a parameter template
    DBEngine String Database engine applicable to a parameter template
    TemplateDescription String Parameter template description

    PgDeal

    Order details

    Used by actions: DescribeOrders.

    Name Type Description
    DealName String Order name
    OwnerUin String User
    Count Integer Number of instances involved in order
    PayMode Integer Billing mode. 0: pay-as-you-go
    FlowId Integer Async task flow ID
    DBInstanceIdSet Array of String Instance ID array

    PolicyRule

    Rule information for security group

    Used by actions: DescribeDBInstanceSecurityGroups.

    Name Type Description
    Action String Policy, Valid values: ACCEPT, DROP.
    CidrIp String Source or destination IP or IP range, such as 172.16.0.0/12.
    PortRange String Port
    IpProtocol String Network protocol. UDP and TCP are supported.
    Description String The rule description

    RawSlowQuery

    The list of slow query details returned by the DescribeSlowQueryList API

    Used by actions: DescribeSlowQueryList.

    Name Type Description
    RawQuery String Slow query statement
    DatabaseName String The database queried by the slow query statement
    Duration Float The execution time of the slow query statement
    ClientAddr String The client that executes the slow query statement
    UserName String The name of the user who executes the slow query statement
    SessionStartTime String The time when the slow query statement starts to execute

    ReadOnlyGroup

    RO group information

    Used by actions: DescribeReadOnlyGroups.

    Name Type Description
    ReadOnlyGroupId String RO group identifier
    Note: this field may return null, indicating that no valid values can be obtained.
    ReadOnlyGroupName String RO group name
    Note: this field may return null, indicating that no valid values can be obtained.
    ProjectId Integer Project ID
    Note: this field may return null, indicating that no valid values can be obtained.
    MasterDBInstanceId String Primary instance ID
    Note: this field may return null, indicating that no valid values can be obtained.
    MinDelayEliminateReserve Integer The minimum number of read-only replicas that must be retained in an RO group
    Note: this field may return null, indicating that no valid values can be obtained.
    MaxReplayLatency Integer Delayed log size threshold
    ReplayLatencyEliminate Integer Whether to remove a read-only replica from an RO group if the sync log size difference between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes).
    MaxReplayLag Float Delay threshold
    ReplayLagEliminate Integer Whether to remove a read-only replica from an RO group if the delay between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes).
    VpcId String VPC ID
    SubnetId String Subnet ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Region String Region ID
    Zone String Availability zone ID
    Status String Status
    ReadOnlyDBInstanceList Array of DBInstance Instance details
    Rebalance Integer Whether to enable automatic load balancing
    DBInstanceNetInfo Array of DBInstanceNetInfo Network information
    NetworkAccessList Array of NetworkAccess Network access list of the RO group (this field has been deprecated)
    Note: this field may return null, indicating that no valid values can be obtained.

    RegionInfo

    Region information such as number and status

    Used by actions: DescribeRegions.

    Name Type Description
    Region String Region abbreviation
    RegionName String Region name
    RegionId Integer Region number
    RegionState String Availability status. UNAVAILABLE: unavailable, AVAILABLE: available
    SupportInternational Integer Whether the resource can be purchased in this region. Valid values: 0 (no), 1 (yes).
    Note: this field may return null, indicating that no valid values can be obtained.

    SecurityGroup

    Security group information

    Used by actions: DescribeDBInstanceSecurityGroups.

    Name Type Description
    ProjectId Integer Project ID
    CreateTime String Creation time
    Inbound Array of PolicyRule Inbound rule
    Outbound Array of PolicyRule Outbound rule
    SecurityGroupId String Security group ID
    SecurityGroupName String Security group name
    SecurityGroupDescription String Security group remarks

    ServerlessDBAccount

    PostgreSQL for Serverless instance account description

    Used by actions: DescribeServerlessDBInstances.

    Name Type Description
    DBUser String Username
    Note: this field may return null, indicating that no valid values can be obtained.
    DBPassword String Password
    Note: this field may return null, indicating that no valid values can be obtained.
    DBConnLimit Integer The maximum number of connections
    Note: this field may return null, indicating that no valid values can be obtained.

    ServerlessDBInstance

    PostgreSQL for Serverless instance description

    Used by actions: DescribeServerlessDBInstances.

    Name Type Required Description
    DBInstanceId String No Instance ID, which is the unique identifier
    Note: this field may return null, indicating that no valid values can be obtained.
    DBInstanceName String No Instance name
    Note: this field may return null, indicating that no valid values can be obtained.
    DBInstanceStatus String No Instance status
    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.
    Zone String No Availability zone
    Note: this field may return null, indicating that no valid values can be obtained.
    ProjectId Integer No Project ID
    Note: this field may return null, indicating that no valid values can be obtained.
    VpcId String No VPC ID
    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.
    DBCharset String No Character set
    Note: this field may return null, indicating that no valid values can be obtained.
    DBVersion String No Database version
    Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime String No Creation time
    Note: this field may return null, indicating that no valid values can be obtained.
    DBInstanceNetInfo Array of ServerlessDBInstanceNetInfo No Instance network information
    Note: this field may return null, indicating that no valid values can be obtained.
    DBAccountSet Array of ServerlessDBAccount No Instance account information
    Note: this field may return null, indicating that no valid values can be obtained.
    DBDatabaseList Array of String No Information of the databases in an instance
    Note: this field may return null, indicating that no valid values can be obtained.
    TagList Array of Tag No The array of tags bound to an instance
    Note: this field may return null, indicating that no valid values can be obtained.
    DBKernelVersion String No Database kernel version
    Note: this field may return null, indicating that no valid values can be obtained.
    DBMajorVersion String No Database major version number
    Note: this field may return null, indicating that no valid values can be obtained.

    ServerlessDBInstanceNetInfo

    PostgreSQL for Serverless instance network description

    Used by actions: DescribeServerlessDBInstances.

    Name Type Description
    Address String Address
    Note: this field may return null, indicating that no valid values can be obtained.
    Ip String IP address
    Note: this field may return null, indicating that no valid values can be obtained.
    Port Integer Port number
    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.
    NetType String Network type
    Note: this field may return null, indicating that no valid values can be obtained.

    SlowlogDetail

    Slow query details

    Used by actions: DescribeDBSlowlogs.

    Name Type Description
    TotalTime Float Total time consumed
    TotalCalls Integer Total number of calls
    NormalQueries Array of NormalQueryItem List of slow SQL statements after desensitization

    SpecInfo

    Purchasable specification details in an AZ in a region.

    Used by actions: DescribeProductConfig.

    Name Type Description
    Region String Region abbreviation, which corresponds to the Region field of RegionSet
    Zone String AZ abbreviate, which corresponds to the Zone field of ZoneSet
    SpecItemInfoList Array of SpecItemInfo Specification details list
    SupportKMSRegions Array of String Regions where KMS is supported
    Note: This field may return null, indicating that no valid value was found.

    SpecItemInfo

    Specification description

    Used by actions: DescribeProductConfig.

    Name Type Description
    SpecCode String Specification ID
    Version String PostgerSQL version number
    VersionName String Full version name corresponding to kernel number
    Cpu Integer Number of CPU cores
    Memory Integer Memory size in MB
    MaxStorage Integer Maximum storage capacity in GB supported by this specification
    MinStorage Integer Minimum storage capacity in GB supported by this specification
    Qps Integer Estimated QPS for this specification
    Pid Integer (Disused)
    Type String Machine type
    MajorVersion String PostgreSQL major version number
    Note: this field may return null, indicating that no valid values can be obtained.
    KernelVersion String PostgreSQL kernel version number
    Note: this field may return null, indicating that no valid values can be obtained.
    IsSupportTDE Integer Whether TDE data encryption is supported. Valid values: 0 (no), 1 (yes)
    Note: This field may return null, indicating that no valid value was found.

    Tag

    The information of tags associated with instances, including TagKey and TagValue

    Used by actions: CloneDBInstance, CreateDBInstances, CreateInstances, CreateReadOnlyDBInstance, CreateServerlessDBInstance, DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups, DescribeServerlessDBInstances.

    Name Type Required Description
    TagKey String Yes Tag key
    TagValue String Yes Tag value

    Version

    Database version information

    Used by actions: DescribeDBVersions.

    Name Type Description
    DBEngine String Database engines. Valid values:
    1. postgresql (TencentDB for PostgreSQL)
    2. mssql_compatible (MSSQL compatible-TencentDB for PostgreSQL)
    DBVersion String Database version, such as 12.4.
    DBMajorVersion String Database major version, such as 12.
    DBKernelVersion String Database kernel version, such as v12.4_r1.3.
    SupportedFeatureNames Array of String List of features supported by the database kernel, such as:
    TDE: Supports data encryption.
    Status String Database version status. Valid values:
    AVAILABLE.
    DEPRECATED.
    AvailableUpgradeTarget Array of String List of versions to which this database version (DBKernelVersion) can be upgraded, including minor and major version numbers available for upgrade (complete kernel version format example: v15.1_v1.6).

    Xlog

    Database Xlog information

    Used by actions: DescribeDBXlogs.

    Name Type Description
    Id Integer Unique backup file ID
    StartTime Timestamp File generation start time
    EndTime Timestamp File generation end time
    InternalAddr String Download address on private network
    ExternalAddr String Download address on public network
    Size Integer Backup file size

    ZoneInfo

    AZ information such as number and status

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ abbreviation
    ZoneName String AZ name
    ZoneId Integer AZ number
    ZoneState String Availability status. Valid values:
    UNAVAILABLE.
    AVAILABLE.
    SELLOUT.
    SUPPORTMODIFYONLY (supports configuration adjustment).
    ZoneSupportIpv6 Integer Whether the AZ supports IPv6 address access
    StandbyZoneSet Array of String AZs that can be used as standby when this AZ is primary
    Note: this field may return null, indicating that no valid values can be obtained.
    上一篇: DeleteReadOnlyGroupNetworkAccess下一篇: Error Codes

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈