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
DokumentasiAPIsTDSQL-C for MySQLData Types

Data Types

Mode fokus
Ukuran font
Terakhir diperbarui: 2026-03-26 22:25:21

Ability

Features supported by the cluster

Used by actions: DescribeClusterDetail, DescribeClusters.

Name Type Required Description
IsSupportSlaveZone String Yes Whether secondary AZ is supported
NonsupportSlaveZoneReason String Yes The causes for no support from an availability zone.
IsSupportRo String Yes Whether read-only instance is supported
NonsupportRoReason String Yes Reasons why RO instances are not supported.
IsSupportManualSnapshot String Yes Whether manual snapshot backup initiation is supported.
IsSupportTransparentDataEncryption String No Whether transparent data encryption is supported.
NoSupportTransparentDataEncryptionReason String No Reasons for no support of transparent data encryption.
IsSupportManualLogic String No Whether manual initiation of logical backup is supported.
IsSupportGlobalEncryption String No Enable global encryption.
NoSupportGlobalEncryptionReason String No The causes for unsupported global encryption.
NoSupportTransparentDataEncryptionReasonCode String No Status code for unsupported tde reason.
NoSupportGlobalEncryptionReasonCode String No Status code for unsupported global encryption.

Account

Database account information

Used by actions: DescribeAccounts.

Name Type Description
AccountName String Database account name
Description String Database account description
CreateTime Timestamp Creation time
UpdateTime Timestamp Update time
Host String Host
MaxUserConnections Integer The max connections

Addr

Database address

Used by actions: DescribeClusterDetail.

Name Type Description
IP String IP address
Port Integer Port

AuditInstanceFilters

Query filter conditions for audit instances

Used by actions: DescribeAuditInstanceList.

Name Type Required Description
Name String Yes Filter condition values. Supports InstanceId-Instance ID, InstanceName-Instance Name, ProjectId-Project ID, TagKey-Tag Key, Tag-Tag (separated by a vertical bar, e.g.: Tagkey
ExactMatch Boolean Yes true indicates exact match; false indicates fuzzy match.
Values Array of String Yes Filter value

AuditInstanceInfo

Audit instance details

Used by actions: DescribeAuditInstanceList.

Name Type Description
ProjectId Integer Project ID.
TagList Array of Tag Tag information

AuditRuleFilters

Filter of rule audit

Used by actions: DescribeAuditRuleWithInstanceIds, ModifyAuditService.

Name Type Required Description
RuleFilters Array of RuleFilters Yes A single audit rule.

AuditRuleTemplateInfo

Details of an audit rule template

Used by actions: DescribeAuditRuleTemplates.

Name Type Description
RuleTemplateId String Rule template ID
RuleTemplateName String Rule template name
RuleFilters Array of RuleFilters Filter of the rule template
Description String Rule template description.
CreateAt String Creation time of a rule template
UpdateAt String Rule template modification time.
AlarmLevel Integer Alarm level. valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
AlarmPolicy Integer Alarm policy. 0 - no alert, 1 - alert.
Status Integer Template status. 0 - no task, 1 - modifying.
AffectedInstances Array of String Template application is used in which instances.

BackupFileInfo

Backup file information

Used by actions: DescribeBackupList.

Name Type Description
SnapshotId Integer Snapshot file ID, which is deprecated. You need to use BackupId.
FileName String Backup file name
FileSize Integer Backup file size
StartTime String Backup start time
FinishTime String Backup end time
BackupType String Backup type. Valid values: snapshot (snapshot backup), logic (logic backup).
BackupMethod String Back mode. auto: auto backup; manual: manual backup
BackupStatus String Backup file status. success: backup succeeded; fail: backup failed; creating: creating backup file; deleting: deleting backup file
SnapshotTime String Backup file time
BackupId Integer Backup ID.
SnapShotType String Specifies the snapshot type. valid values: full (full snapshot); increment (incremental snapshot).
BackupName String Specifies the remark of the backup file.

BackupLimitClusterRestriction

Specifies the backup download cluster restrictions parameter.

Used by actions: DescribeBackupDownloadRestriction, DescribeBackupDownloadUserRestriction.

Name Type Required Description
ClusterId String No Cluster ID
BackupLimitRestriction BackupLimitRestriction No Download limit configuration.

BackupLimitRestriction

Specifies the backup download limit parameter.

Used by actions: DescribeBackupDownloadRestriction, DescribeBackupDownloadUrl, DescribeBackupDownloadUserRestriction, DescribeBinlogDownloadUrl.

Name Type Required Description
LimitType String No Restriction type.
VpcComparisonSymbol String No This parameter only supports In, which indicates that the vpc specified by LimitVpc can be downloaded. the default is In.
IpComparisonSymbol String No Specified ips can download; specified ips are not allowed to download.
LimitVpcs Array of BackupLimitVpcItem No Specifies the vpc setting for download restrictions.
Note: This field may return null, indicating that no valid values can be obtained.
LimitIps Array of String No Specifies the ip settings for limiting downloads.
Note: This field may return null, indicating that no valid values can be obtained.

BackupLimitVpcItem

VPC settings for restricting backup download sources.

Used by actions: DescribeBackupDownloadUrl, DescribeBinlogDownloadUrl, ModifyBackupDownloadRestriction, ModifyBackupDownloadUserRestriction.

Name Type Required Description
Region String No Specifies the region for limiting download sources. currently only supports the current region.
VpcList Array of String No Limit the vpc list for downloads.

BillingResourceInfo

Billable resource information

Used by actions: DescribeResourcesByDealName.

Name Type Description
ClusterId String Cluster ID
InstanceIds Array of String Instance ID list
DealName String Order ID

BindInstanceInfo

Information of the instance bound to the resource pack

Used by actions: DescribeResourcePackageList.

Name Type Description
InstanceId String ID of the bound cluster.
InstanceRegion String The region where the bound instance is located.
InstanceType String Type of the bound instance.
ExtendIds Array of String The instance ID under the bound cluster.

BinlogConfigInfo

Specifies the binlog configuration message.

Used by actions: DescribeBinlogConfig, ModifyBinlogConfig.

Name Type Required Description
BinlogSaveDays Integer Yes Specifies the retention time of binlogs.
BinlogCrossRegionsEnable String Yes Whether binlog cross-region backup is enabled.
BinlogCrossRegions Array of String No binlog in a different region.
Note: This field may return null, indicating that no valid values can be obtained.

BinlogItem

Binlog description

Used by actions: DescribeBinlogs.

Name Type Description
FileName String Binlog filename
FileSize Integer File size in bytes
StartTime String Transaction start time
FinishTime String Transaction end time
BinlogId Integer Binlog file ID

BizTaskInfo

Task information

Used by actions: DescribeTasks.

Name Type Description
ID Integer Task id
AppId Integer User appid
ClusterId String cluster id
Region String Region
CreateTime String Task Creation Time
DelayTime String Specifies the delayed execution time.
ErrMsg String Task failure information.
FlowId Integer asynchronous task flow id
Input String task input information
InstanceGroupId String instance group id
InstanceId String Instance id
ObjectId String Task Operation Target id
ObjectType String Task Operation Target Type
Operator String Operator uin
Output String task output information
Status String Task Status
TaskType String task type
TriggerTaskId Integer Parent Task ID that Triggered This Task
UpdateTime String Update Time
StartTime String Task Start Time
EndTime String Task End Time
ClusterName String Cluster Name
InstanceName String Instance Name
Process Integer Task Progress
CreateClustersData CreateClustersData Create cluster task information.
RollbackData RollbackData Cluster rollback task information.
ModifyInstanceData ModifyInstanceData Instance configuration change task information.
ManualBackupData ManualBackupData Manual Backup Task Information
ModifyDbVersionData ModifyDbVersionData Modify kernel version task information.
ClusterSlaveData ClusterSlaveData Cluster availability zone information.
SwitchClusterLogBin SwitchClusterLogBin Cluster Log Conversion
ModifyInstanceParamsData BizTaskModifyParamsData Instance Parameter Modification
TaskMaintainInfo TaskMaintainInfo Maintenance time.
InstanceCLSDeliveryInfos Array of InstanceCLSDeliveryInfo Instance log delivery information.
TaskProgressInfo TaskProgressInfo Task progress information.

BizTaskModifyInstanceParam

Instance Parameter Modification Task Details

Used by actions: DescribeTasks.

Name Type Description
InstanceId String Instance ID
ModifyInstanceParamList Array of ModifyParamItem Details of instance parameter modification task.

BizTaskModifyParamsData

Parameter Modification Task Data

Used by actions: DescribeTasks.

Name Type Description
ClusterId String Cluster ID
ClusterParamList Array of ModifyParamItem Cluster parameter modification data.
ModifyInstanceParams Array of BizTaskModifyInstanceParam Instance parameter modification data.

CLSInfo

CLS Log Delivery Configuration

Used by actions: CreateCLSDelivery.

Name Type Required Description
TopicOperation String Yes Log topic operation: optional create, reuse.
create: create a new log topic using TopicName.
reuse: use an existing log topic by specifying TopicId.
Combining the use of an existing log topic and creating a new log set is not allowed.
GroupOperation String Yes Log set operation: optional create, reuse.
create: create a new log set using GroupName.
reuse: use an existing log set by specifying GroupId.
Combining the use of an existing log topic and creating a new log set is not allowed.
Region String Yes Log Delivery Region
TopicId String No log topic id
TopicName String No log topic name
GroupId String No log set id
GroupName String No log set name

ClusterInstanceDetail

Cluster instance information

Used by actions: DescribeClusterDetail.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
InstanceType String Engine type
InstanceStatus String Instance status
InstanceStatusDesc String Instance status description
InstanceCpu Integer Number of CPU cores
InstanceMemory Integer Memory
InstanceStorage Integer Disk
InstanceRole String Instance role
MaintainStartTime Integer Execution start time (seconds from 0 o'clock).
MaintainDuration Integer Specifies the continuous time. the unit is second.
MaintainWeekDays Array of String Specifies the time when it can be executed. valid values: ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"].
ServerlessStatus String serverless instance substatus.
InstanceTasks Array of ObjectTask Instance task information.
InstanceDeviceType String Instance machine type.
1. common: general.
2. exclusive, dedicated.
InstanceStorageType String Instance storage type.
Description: this parameter returns a value only when querying resources belonging to LibraDB.
DbMode String Database type.
NodeList Array of String Node list
Description: this parameter returns a value only when querying LibraDB resources.

ClusterReadOnlyValue

Cluster read-only switch list.

Used by actions: DescribeClusterReadOnly.

Name Type Description
ClusterId String Cluster ID
ReadOnlyValue String Specifies the value of the read-only switch.

ClusterSlaveData

Cluster AZ Information

Used by actions: DescribeTasks.

Name Type Description
OldMasterZone String Old primary availability zone.
OldSlaveZone Array of String Standby AZ
NewMasterZone String New primary availability zone.
NewSlaveZone Array of String New Standby AZ
NewSlaveZoneAttr Array of SlaveZoneAttrItem New from availability zone attribute.
OldSlaveZoneAttr Array of SlaveZoneAttrItem Old availability zone attributes.

ClusterTaskId

Cluster task ID.

Used by actions: ModifyClusterReadOnly.

Name Type Description
ClusterId String Cluster ID
TaskId String Task ID

CreateClustersData

Cluster Creation Task Information

Used by actions: DescribeTasks.

Name Type Description
Cpu Integer Instance CPU
Memory Integer Instance Memory
StorageLimit Integer Cluster storage limit

CrossRegionBackupItem

Cross-Region backup describes the backup information in each region.

Used by actions: DescribeTasks.

Name Type Description
CrossRegion String Target region for backup.
BackupId Integer Target region's backup task ID.
BackupStatus String Backup status in the target region.

CynosdbCluster

Cluster information

Used by actions: DescribeClusters.

Name Type Required Description
Status String Yes Cluster status. Valid values are as follows:
creating
running
isolating
isolated
activating (removing isolation)
offlining (deactivating)
offlined (deactivated)
deleting
deleted
UpdateTime String Yes Update time
Zone String Yes AZ
ClusterName String Yes Cluster name
Region String Yes Region
DbVersion String Yes Database version
ClusterId String Yes Cluster ID
InstanceNum Integer Yes Number of instances
Uin String Yes User UIN
DbType String Yes Engine type.
AppId Integer Yes User appid.
StatusDesc String Yes Cluster status description
CreateTime String Yes Cluster Creation Time
PayMode Integer Yes Payment mode. 0: pay-as-you-go; 1: yearly/monthly subscription.
PeriodEndTime String Yes Expiration time.
Vip String Yes Cluster read/write vip.
Vport Integer Yes Cluster read/write vport.
ProjectID Integer Yes Project ID
VpcId String No Specifies the virtual private cloud ID.
SubnetId String No Specifies the subnet ID.
CynosVersion String No Specifies the cynos kernel version.
CynosVersionTag String No cynos version tag.
StorageLimit Integer No Specifies the storage capacity.
RenewFlag Integer No Renewal Flag
ProcessingTask String No Task being processed.
Tasks Array of ObjectTask No Task array of the cluster.
ResourceTags Array of Tag No Array of tags bound to the cluster.
DbMode String No Db type (NORMAL, SERVERLESS).
ServerlessStatus String No Specifies the status of the SERVERLESS cluster when the Db type is SERVERLESS. valid values:.
resume
pause
Storage Integer No Cluster prepaid storage size.
StorageId String No Cluster storage ID for prepaid storage, specifies the storage ID used for prepaid storage modification.
StoragePayMode Integer No Cluster storage payment mode. 0: pay-as-you-go; 1: yearly/monthly subscription.
MinStorageSize Integer No Minimum storage value corresponding to cluster computing specifications.
MaxStorageSize Integer No The maximum storage value corresponding to the cluster computing specification.
NetAddrs Array of NetAddr No Specifies the cluster network information.
PhysicalZone String No Physical availability zone.
MasterZone String No Primary AZ.
HasSlaveZone String No Whether there is an availability zone.
SlaveZones Array of String No Secondary AZ.
BusinessType String No Business type.
IsFreeze String No Whether to freeze.
OrderSource String No Order Source
Ability Ability No Capacity.
ResourcePackages Array of ResourcePackage No Specifies the information of the resource package bound to the instance (only the storage resource package is returned here, that is, packageType=DISK).
GdnId String No Global database unique Id.
GdnRole String No Cluster role. primary cluster - primary, slave cluster - standby. if GdnId is empty, the field is invalid.

CynosdbClusterDetail

Cluster details

Used by actions: DescribeClusterDetail.

Name Type Description
ClusterId String Cluster ID
ClusterName String Cluster name
Region String Region
Zone String AZ
PhysicalZone String Physical availability zone.
Status String Status. supported values are as follows:.
-Creating: creating.
- running: running.
-isolating.
-Isolated: isolated.
-activating: restore from recycle bin.
-offlining: offline.
-offlined: offline.
- deleting: deleting.
- deleted: deleted.
StatusDesc String Status description
ServerlessStatus String Serverless cluster status when the database type is SERVERLESS. Valid values:
resume
resuming
pause
pausing
StorageId String Storage Id.
Storage Integer Storage size in gb.
MaxStorageSize Integer Maximum storage specification, in gb.
MinStorageSize Integer Specifies the minimum storage specification, in gb.
StoragePayMode Integer Storage billing type. 1 indicates yearly/monthly subscription, and 0 indicates pay-as-you-go.
VpcName String VPC name
VpcId String Unique VPC ID
SubnetName String Subnet name
SubnetId String Subnet ID
Charset String Character set
CreateTime String Creation time
DbType String Database type
DbMode String Db type:
  • NORMAL
  • SERVERLESS
    • .
    DbVersion String Database version
    StorageLimit Integer Specifies the maximum storage space.
    UsedStorage Integer Used capacity
    Vip String VIP
    Vport Integer vport
    RoAddr Array of Addr VIP and vport of the read-only instance in a cluster.
    Ability Ability Functions supported by the cluster.
    CynosVersion String Specifies the cynos version.
    BusinessType String Business type.
    HasSlaveZone String Whether there is an availability zone.
    IsFreeze String Whether to freeze.
    Tasks Array of ObjectTask Task list.
    MasterZone String Primary AZ.
    SlaveZones Array of String Availability zone list.
    InstanceSet Array of ClusterInstanceDetail Instance information
    PayMode Integer Billing mode
    PeriodEndTime String Expiration time
    ProjectID Integer Project ID
    ResourceTags Array of Tag Array of tags bound to instance
    ProxyStatus String Proxy status.
    LogBin String binlog switch. valid values: ON, OFF.
    IsSkipTrade String Specifies whether to skip the transaction.
    PitrType String PITR type: valid values: normal, redo_pitr.
    IsOpenPasswordComplexity String Whether to enable password complexity.
    NetworkStatus String Network type.
    ResourcePackages Array of ResourcePackage The resource package information that is bound to the cluster.
    RenewFlag Integer Auto-Renewal flag. 1 indicates auto-renewal. 0 indicates non-renewal upon expiration.
    NetworkType String Specifies the node network type.
    SlaveZoneAttr Array of SlaveZoneAttrItem Secondary availability zone property.
    CynosVersionTag String Version Tag.
    GdnId String Global database network unique id.
    GdnRole String The role of clusters in the global data network.
    primary cluster.
    Slave cluster - standby.
    If empty, the field is invalid.
    UsedArchiveStorage Integer Secondary storage usage, unit: G.
    ArchiveStatus String Archiving status, enumeration value
  • normal: normal
  • archiving: archiving
  • resuming: recovering
  • archived: archived
    • .
    ArchiveProgress Integer Archive progress, percentage.
    IsOpenTDE Boolean Whether transparent encryption is enabled.

    CynosdbErrorLogItem

    Types of the returned error logs for an instance

    Used by actions: DescribeInstanceErrorLogs.

    Name Type Description
    Timestamp Integer Log timestamp.
    Level String Log level.
    Content String Log content.

    CynosdbInstance

    Instance information

    Used by actions: DescribeInstances, DescribeIsolatedInstances.

    Name Type Description
    Uin String User Uin
    AppId Integer User AppId
    ClusterId String Cluster ID
    ClusterName String Cluster name
    InstanceId String Instance ID
    InstanceName String Instance name
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Status String Instance status
    StatusDesc String Instance status description
    DbMode String Instance type, which is used to indicate whether it is a serverless instance.
    DbType String Database type
    DbVersion String Database version
    Cpu Integer Number of CPU cores
    Memory Integer Memory in GB
    Storage Integer Storage capacity in GB
    InstanceType String Instance type
    InstanceRole String Current instance role
    UpdateTime Timestamp Update time
    CreateTime Timestamp Creation time
    VpcId String VPC ID
    SubnetId String Subnet ID
    Vip String Private IP of instance
    Vport Integer Private port of instance
    PayMode Integer Billing mode
    PeriodEndTime Timestamp Instance expiration time
    DestroyDeadlineText String Termination deadline
    IsolateTime Timestamp Isolation time
    NetType Integer Network type
    WanDomain String Public domain name
    WanIP String Public IP
    WanPort Integer Public port
    WanStatus String Public network status
    DestroyTime String Instance termination time
    CynosVersion String TDSQL-C kernel version
    ProcessingTask String Task in progress
    RenewFlag Integer Renewal flag
    MinCpu Float Minimum number of CPU cores for serverless instance
    MaxCpu Float Maximum number of CPU cores for serverless instance
    ServerlessStatus String Serverless instance status. Valid values:
    resume
    pause
    StorageId String Prepayment storage Id.
    StoragePayMode Integer Storage billing mode
    PhysicalZone String Physical zone
    BusinessType String Business type.
    Tasks Array of ObjectTask Task
    IsFreeze String Whether to freeze.
    ResourceTags Array of Tag The resource tag
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterZone String Primary AZ.
    SlaveZones Array of String Replica AZ
    Note: This field may return null, indicating that no valid value can be obtained.
    InstanceNetInfo Array of InstanceNetInfo Network information of the instance.
    ResourcePackages Array of ResourcePackage Information of the resource pack bound to an instance when packageType is CCU. Note: This field may return null, indicating that no valid values can be obtained.
    InstanceIndexMode String Specifies the instance index form. valid values include mixedRowColumn (row and column hybrid storage) and onlyRowIndex (row-only storage).
    InstanceAbility InstanceAbility Supported capabilities of the existing instance.
    DeviceType String Instance machine type.
    InstanceStorageType String Specifies the instance storage type.
    CynosVersionTag String Unknown field.
    NodeList Array of String Specifies the node information of libradb.

    CynosdbInstanceDetail

    Instance details

    Used by actions: DescribeInstanceDetail.

    Name Type Description
    Uin String User Uin
    AppId Integer User AppId
    ClusterId String Cluster ID
    ClusterName String Cluster name
    InstanceId String Instance ID
    InstanceName String Instance name
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Status String Instance status
    StatusDesc String Instance status description
    ServerlessStatus String Serverless instance status. Valid values:
    resume
    pause
    DbType String Database type
    DbVersion String Database version
    Cpu Integer Number of CPU cores
    Memory Integer Memory in GB
    Storage Integer Storage capacity in GB
    InstanceType String Instance type
    InstanceRole String Current instance role
    UpdateTime Timestamp Update time
    CreateTime Timestamp Creation time
    PayMode Integer Billing mode
    PeriodEndTime Timestamp Instance expiration time
    NetType Integer Network type
    VpcId String VPC ID
    SubnetId String Subnet ID
    Vip String Private IP of instance
    Vport Integer Private port of instance
    WanDomain String Public domain name of instance
    Charset String Character set
    CynosVersion String TDSQL-C kernel version
    RenewFlag Integer Renewal flag
    MinCpu Float The minimum number of CPU cores for a serverless instance
    MaxCpu Float The maximum number of CPU cores for a serverless instance
    DbMode String Db type:
  • NORMAL
  • SERVERLESS
    • .

    DatabasePrivileges

    Database permission list

    Used by actions: ModifyAccountPrivileges.

    Name Type Required Description
    Db String Yes Database.
    Privileges Array of String Yes Permission list

    DatabaseTables

    Database table information

    Used by actions: CreateBackup, SearchClusterTables.

    Name Type Required Description
    Database String No Database name
    Tables Array of String No Table name list.

    DbInfo

    Database details

    Used by actions: DescribeClusterDetailDatabases.

    Name Type Description
    DbName String Database name
    CharacterSet String Character set
    Status String Database status
    CollateRule String Collation
    Description String Specifies the remark of the database.
    UserHostPrivileges Array of UserHostPrivilege User permission
    DbId Integer Database ID
    CreateTime Timestamp ISO8601 Creation time
    UpdateTime Timestamp ISO8601 Update time.
    AppId Integer User appid.
    Uin String User UIN
    ClusterId String Cluster ID

    DeliverSummary

    Log shipping information.

    Used by actions: DescribeAuditInstanceList.

    Name Type Description
    DeliverType String Select the delivery type, storage class, message channel.
    DeliverSubType String Specifies the delivery subtype: cls, ckafka.
    DeliverConsumer String Sender.
    DeliverConsumerName String Specifies the name of the sender.

    ErrorLogItemExport

    The export format for an error log

    Used by actions: ExportInstanceErrorLogs.

    Name Type Required Description
    Timestamp String No Time
    Level String No Specifies the log level. valid values are note, warning, and error.
    Content String No Log content.

    ExchangeInstanceInfo

    Exchange Instance Information

    Used by actions: DescribeTasks.

    Name Type Description
    SrcInstanceInfo RollbackInstanceInfo Source instance information.
    DstInstanceInfo RollbackInstanceInfo Target instance information.

    ExchangeRoGroupInfo

    Swap RO group information

    Used by actions: DescribeTasks.

    Name Type Description
    SrcRoGroupInfo RollbackRoGroupInfo Source RO group information.
    DstRoGroupInfo RollbackRoGroupInfo Target RO group information.

    GoodsPrice

    Item price.

    Used by actions: InquirePriceMultiSpec.

    Name Type Description
    InstancePrice TradePrice Specifies the instance price.
    Note: This field may return null, indicating that no valid values can be obtained.
    StoragePrice TradePrice Specifies the storage price.
    Note: This field may return null, indicating that no valid values can be obtained.
    GoodsSpec GoodsSpec Specifies the product specification.
    Note: This field may return null, indicating that no valid values can be obtained.

    GoodsSpec

    Product specification.

    Used by actions: InquirePriceMultiSpec.

    Name Type Required Description
    GoodsNum Integer No Number of products
    Note: This field may return null, indicating that no valid values can be obtained.
    Cpu Integer No Number of CPU cores. required for PREPAID and POSTPAID instance types.
    Note: This field may return null, indicating that no valid values can be obtained.
    Memory Integer No Memory size in gb. required for PREPAID and POSTPAID instance types.
    Note: This field may return null, indicating that no valid values can be obtained.
    Ccu Float No Ccu size. required for serverless type.
    Note: This field may return null, indicating that no valid values can be obtained.
    StorageLimit Integer No Storage size. required for PREPAID storage type.
    Note: This field may return null, indicating that no valid values can be obtained.
    TimeSpan Integer No Purchase duration.
    Note: This field may return null, indicating that no valid values can be obtained.
    TimeUnit String No Duration unit.
    Note: This field may return null, indicating that no valid values can be obtained.
    DeviceType String No Machine type.

    InputAccount

    Account. Valid values: accountName, host.

    Used by actions: DeleteAccounts, ModifyAccountHost, ModifyAccountPrivileges.

    Name Type Required Description
    AccountName String Yes Account
    Host String No Host. Default value: %

    InstanceAbility

    Allowed Operations List for Instances

    Used by actions: DescribeInstances, DescribeIsolatedInstances.

    Name Type Description
    IsSupportForceRestart String Specifies whether the instance supports forced reboot. valid values: yes (supported), no (unsupported).
    NonsupportForceRestartReason String Specifies the causes for not supporting forced reboot.

    InstanceAuditRule

    Audit rule details of the instance, which is an output parameter of the DescribeAuditRuleWithInstanceIds API.

    Used by actions: DescribeAuditRuleWithInstanceIds.

    Name Type Description
    InstanceId String Instance ID.
    AuditRule Boolean Specifies whether it is a rule-based audit. true - rule-based audit; false - comprehensive audit.
    AuditRuleFilters Array of AuditRuleFilters Specifies the audit rule details. valid when AuditRule=true.
    OldRule Boolean Whether it is an audit policy.
    RuleTemplates Array of RuleTemplateInfo The rule template details of the instance application.

    InstanceAuditStatus

    Audit instance details

    Used by actions: DescribeAuditInstanceList.

    Name Type Description
    InstanceId String Instance ID.
    AuditStatus String Audit status. ON- Audit is enabled; OFF- Audit is disabled.
    LogExpireDay Integer Specifies the log retention period.
    HighLogExpireDay Integer High-Frequency storage duration.
    LowLogExpireDay Integer Specifies the duration of low-frequency storage.
    BillingAmount Float Specifies the log storage volume.
    HighRealStorage Float Specifies the high-frequency storage volume.
    LowRealStorage Float Specifies the infrequent access storage size.
    AuditAll Boolean Specifies whether it is a full audit. true - indicates a full audit.
    CreateAt String Specifies the audit activation time.
    InstanceInfo AuditInstanceInfo Instance-Related information.
    RealStorage Float Specifies the total storage capacity.
    RuleTemplateIds Array of String The rule template applied to the instance.
    Deliver String Specifies whether to enable log delivery: ON, OFF.
    DeliverSummary Array of DeliverSummary Log shipping type.

    InstanceCLSDeliveryInfo

    Instance Log Delivery Information

    Used by actions: DescribeInstanceCLSLogDelivery, DescribeTasks.

    Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    TopicId String Log topic id.
    TopicName String Log topic name
    GroupId String Log set id.
    GroupName String Log set name.
    Region String Log delivery region.
    Status String Delivery status: creating, running, offlining, offlined.
    LogType String Log type.

    InstanceInitInfo

    Instance initialization configuration information

    Used by actions: CreateClusters, RollbackToNewCluster.

    Name Type Required Description
    Cpu Integer Yes Instance CPU
    Memory Integer Yes Instance memory
    InstanceType String Yes Instance type. Valid values:rw, ro.
    InstanceCount Integer Yes Number of the instances. Value range: 1-15.
    MinRoCount Integer No Minimum number of serverless instances. Value range: 1-15.
    MaxRoCount Integer No Maximum number of serverless instances. Value range: 1-15.
    MinRoCpu Float No Minimum specifications for serverless instance
    MaxRoCpu Float No Maximum specifications for serverless instance
    DeviceType String No Instance machine type.
    1. common: general.
    2. exclusive: exclusive.

    InstanceNameWeight

    Instance weight.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    InstanceName String No Instance name. specifies the name defined by InstanceInitInfo.InstanceName in cluster creation.
    Weight Integer No Weight

    InstanceNetInfo

    Instance network information

    Used by actions: DescribeInstances, DescribeIsolatedInstances.

    Name Type Description
    InstanceGroupType String Network type.
    InstanceGroupId String Instance group ID
    VpcId String Specifies the virtual private cloud ID.
    SubnetId String Specifies the subnet ID.
    NetType Integer Network type. valid values: 0 (basic network), 1 (vpc network), 2 (blackstone network).
    Vip String VPC IP.
    Vport Integer VPC port.
    WanDomain String Specifies the public network domain name.
    WanIP String Public IP address
    WanPort Integer Public network port.
    WanStatus String Public network enabled status.

    InstanceParamItem

    Instance parameter information

    Used by actions: DescribeInstanceParams.

    Name Type Description
    InstanceId String Instance ID
    ParamsItems Array of ParamItemDetail List of instance parameters

    InstanceSpec

    Details of purchasable instance specifications. Cpu and Memory determine the instance specification during instance creation. The value range of the storage capacity is [MinStorageSize,MaxStorageSize]

    Used by actions: DescribeInstanceSpecs.

    Name Type Description
    Cpu Integer Number of instance CPU cores
    Memory Integer Instance memory in GB
    MaxStorageSize Integer Maximum instance storage capacity GB
    MinStorageSize Integer Minimum instance storage capacity GB
    HasStock Boolean Whether there is an inventory.
    MachineType String Machine type
    MaxIops Integer Maximum IOPS
    MaxIoBandWidth Integer Maximum bandwidth
    ZoneStockInfos Array of ZoneStockInfo Regional inventory information.
    StockCount Integer Inventory quantity.

    IntegrateCreateClusterConfig

    Integrated cluster configuration.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    BinlogSaveDays Integer No Retention days of binlog. value range: 7-1830.
    BackupSaveDays Integer No Specifies the backup retention days. value range: 7-1830.
    SemiSyncTimeout Integer No Specifies the semi-sync timeout period. value range: [1000,4294967295].
    ProxyEndPointConfigs Array of ProxyEndPointConfigInfo No proxy connection address configuration message.

    IntegrateInstanceInfo

    Initializes the configuration information of an instance.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    Cpu Integer Yes Specifies the cpu of the instance.
    Memory Integer Yes Specifies the instance memory.
    InstanceType String Yes Instance type (rw/ro).
    InstanceCount Integer Yes Number of instances. value range: [1,15].
    DeviceType String No Instance machine type. valid values: universal type (common), exclusive type.

    LogicBackupConfigInfo

    Logical Backup Configuration Information

    Used by actions: DescribeBackupConfig, ModifyBackupConfig.

    Name Type Required Description
    LogicBackupEnable String No Whether automatic logical backup is enabled.
    LogicBackupTimeBeg Integer No Specifies the automatic logic backup start time.
    LogicBackupTimeEnd Integer No Specifies the termination time of automatic logical backup.
    LogicReserveDuration Integer No Specifies the retention time for automatic logical backup.
    LogicCrossRegionsEnable String No Whether cross-regional logical backup is enabled.
    LogicCrossRegions Array of String No Logical Backup Cross-Region

    ManualBackupData

    Manual Backup Task Information

    Used by actions: DescribeTasks.

    Name Type Description
    BackupType String Backup type. snapshot-snapshot backup
    BackupMethod String Backup method. auto-automatic backup, manual-manual
    SnapshotTime String Backup Time
    CrossRegionBackupInfos Array of CrossRegionBackupItem Detailed information of cross-region backup items.
    Note: This field may return null, indicating that no valid values can be obtained.

    ModifiableInfo

    Details of whether the parameter can be modified

    Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity, DescribeParamTemplateDetail.

    Name Type Description
    IsModifiable Integer Whether the parameter is modifiable. 1: Yes 0: No

    ModifyDbVersionData

    Database Kernel Version Modification Task Information

    Used by actions: DescribeTasks.

    Name Type Description
    OldVersion String pre-modification version
    NewVersion String Post-modification Version
    UpgradeType String Upgrade Method

    ModifyInstanceData

    Instance Resizing Task Information

    Used by actions: DescribeTasks.

    Name Type Description
    Cpu Integer CPU After Resizing
    Memory Integer Memory After Resizing
    StorageLimit Integer Storage Limit After Resizing
    OldCpu Integer CPU Before Resizing
    OldMemory Integer Memory Before Resizing
    OldStorageLimit Integer Storage Limit Before Resizing
    OldDeviceType String Instance machine type before scaling.
    DeviceType String Instance machine type after scaling.
    UpgradeType String Upgrade Method. Switchover is performed after upgrade completion or during maintenance windows
    LibraNodeCount Integer Specifies the quantity of libra nodes.
    OldLibraNodeCount Integer Specifies the original quantity of libra nodes.

    ModifyParamItem

    Information of the modified instance parameter

    Used by actions: AddInstances, DescribeTasks, ModifyInstanceParam, ModifyParamTemplate.

    Name Type Required Description
    ParamName String Yes Parameter name
    CurrentValue String Yes Current parameter value
    OldValue String No Old parameter value (useful only in output parameters).
    Component String No libra component type.

    Module

    Modules supported by the system

    Used by actions: DescribeZones.

    Name Type Description
    IsDisable String Whether it is supported. Valid values: yes, no.
    ModuleName String Module name

    NetAddr

    Network information

    Used by actions: DescribeClusters, DescribeProxies.

    Name Type Required Description
    Vip String No Private IP address
    Vport Integer No Specifies the private network port number.
    WanDomain String No Specifies the public network domain name.
    WanPort Integer No Specifies the public network port number.
    NetType String No Network type (ro - read-only, rw/ha - read-write).
    UniqSubnetId String No Specifies the subnet ID.
    UniqVpcId String No Specifies the virtual private cloud ID.
    Description String No Description information
    WanIP String No Public IP address
    WanStatus String No Specifies the public network status.
    InstanceGroupId String No Instance group ID

    NewAccount

    The newly created x08 account

    Used by actions: CreateAccounts.

    Name Type Required Description
    AccountName String Yes Account name, which can contain 1-16 letters, digits, and underscores. It must begin with a letter and end with a letter or digit.
    AccountPassword String Yes Password, which can contain 8-64 characters.
    Host String Yes Host
    Description String No Description
    MaxUserConnections Integer No Maximum number of user connections, which cannot be above 10,240.

    ObjectTask

    Task information

    Used by actions: DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeProxies.

    Name Type Required Description
    TaskId Integer No Task auto-increment ID.
    TaskType String No Task type
    TaskStatus String No Status of tasks.
    ObjectId String No Task ID (cluster ID
    ObjectType String No Task type

    Package

    Resource pack

    Used by actions: DescribeResourcePackageList.

    Name Type Description
    AppId Integer AppID
    PackageId String The unique ID of the resource package.
    PackageName String Resource package name.
    PackageType String Specifies the resource package type.
    CCU: compute resource package. DISK: storage resource package.
    PackageRegion String Resource package region of use.
    China - common in the chinese mainland. overseas - universally applicable in hong kong (china), macao (china), taiwan (china), and overseas.
    Status String Specifies the status of the resource package.
    creating - indicates that it is in the process of being created.
    {using} specifies that it is in use.
    expired-expired;.
    normal_finish - specifies that it is used up.
    Apply_refund: apply for a refund.
    Specifies that the fee has been refunded.
    PackageTotalSpec Float Total resource package quantity.
    PackageUsedSpec Float Used amount of resource package.
    HasQuota Boolean Whether there is inventory surplus.
    BindInstanceInfos Array of BindInstanceInfo Specifies the bound instance information.
    StartTime String Specifies the effective time: 2022-07-01 00:00:00.
    ExpireTime String Specifies the expiration time: 2022-08-01 00:00:00.
    HistoryBindResourceInfos Array of BindInstanceInfo Information of the instance historically bound (now unbound) to the resource pack.

    PackageDetail

    Resource pack details

    Used by actions: DescribeResourcePackageDetail.

    Name Type Description
    AppId Integer AppId account ID.
    PackageId String The unique ID of the resource package.
    InstanceId String Instance ID
    SuccessDeductSpec Float Successfully deduct capacity.
    PackageTotalUsedSpec Float The used capacity of the resource package up to the present.
    StartTime String Deduction start time.
    EndTime String Deduction end time.
    ExtendInfo String Extension Information

    PackagePriority

    Resource package deduction priority.

    Used by actions: ModifyResourcePackagesDeductionPriority.

    Name Type Required Description
    PackageId String No The resource pack whose deduction priority needs to be customized.
    DeductionPriority Integer No Custom deduction priority.

    ParamDetail

    Instance parameter details

    Used by actions: DescribeParamTemplateDetail.

    Name Type Description
    ParamName String Parameter name
    ParamType String Parameter type. Valid values: integer, enum, float, string, func.
    SupportFunc Boolean Whether func is supported. Valid values: true (supported), false (not supported).
    Default String Default value
    Description String Parameter description
    CurrentValue String Current value of the parameter
    NeedReboot Integer Whether to restart the database for the modified parameters to take effect. Valid values: 0 (no), 1 (yes).
    Max String Maximum value of the parameter
    Min String Minimum value of the parameter
    EnumValue Array of String Optional enumerated values of the parameter. if it is a non-enumerated value, it is empty.
    IsGlobal Integer Valid values: 1 (global parameter), 0 (non-global parameter).
    MatchType String The match type. Valid value: multiVal.
    MatchValue String Match values, which will be separated by comma when MatchType is multiVal.
    IsFunc Boolean true - indicates a formula. false - indicates it is not a formula.
    Func String Specifies that when the parameter is set as a formula, Func returns the set formula content.
    ModifiableInfo ModifiableInfo Whether the parameter is modifiable.
    FuncPattern String The default formula style of parameters that support formulas.

    ParamInfo

    Parameter information

    Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String If the parameter is of type enum/string/bool, the available options list.
    Max String Maximum value when parameter type is float or integer.
    Min String Minimum value when parameter type is float or integer.
    ParamName String Parameter name
    NeedReboot Integer Whether to restart the instance for the modified parameters to take effect.
    ParamType String Parameter type: integer, float, string, enum, bool.
    MatchType String Match type. Regex can be used when parameter type is string. Valid value: multiVal.
    MatchValue String Match values, which will be separated by semicolon when match type is multiVal.
    Description String Parameter description
    IsGlobal Integer Whether it is a global parameter.
    ModifiableInfo ModifiableInfo Whether the parameter is modifiable.
    IsFunc Boolean Whether it is a function.
    Func String Function.
    FuncPattern String The default formula style of parameters that support formulas.

    ParamItem

    Parameter to be modified

    Used by actions: CreateClusters, CreateIntegrateCluster, CreateParamTemplate, ModifyClusterParam, RollbackToNewCluster.

    Name Type Required Description
    ParamName String Yes Parameter name
    CurrentValue String Yes New value
    OldValue String Yes Original value

    ParamItemDetail

    Instance parameter information

    Used by actions: DescribeInstanceParams.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String Enumerated values of the parameter It is null if the parameter is non-enumerated.
    IsGlobal Integer Valid values: 1 (global parameter), 0 (non-global parameter).
    Max String Maximum value
    Min String Minimum value
    NeedReboot Integer Whether to restart the database for the modified parameters to take effect. Valid values: 0 (no), 1 (yes)
    ParamName String Parameter name
    ParamType String Parameter type. Valid values: integer, enum, float, string, func.
    Description String Parameter description
    IsFunc Boolean Whether the type is a formula.
    Func String Parameter configuration formula.
    FuncPattern String The default formula style of parameters that support formulas.

    ParamItemInfo

    Parameter Change Information

    Used by actions: DescribeChangedParamsAfterUpgrade.

    Name Type Description
    ParamName String Parameter name.
    NewValue String New parameter value.
    OldValue String Old parameter value.
    ValueFunction String Parameter formula.

    ParamTemplateListInfo

    Parameter template information

    Used by actions: DescribeParamTemplates.

    Name Type Description
    Id Integer Parameter template ID
    TemplateName String Parameter template name
    TemplateDescription String Parameter template description
    EngineVersion String Engine version
    DbMode String Database Type. Valid values: NORMAL, SERVERLESS.
    ParamInfoSet Array of TemplateParamInfo Parameter template details
    Note: This field may return null, indicating that no valid values can be obtained.

    PolicyRule

    Security group rule

    Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

    Name Type Description
    Action String Policy, which can be ACCEPT or DROP
    CidrIp String Source IP or source IP range, such as 192.168.0.0/16
    PortRange String Port
    IpProtocol String Network protocol, such as UDP and TCP
    ServiceModule String Protocol port ID or protocol port group ID.
    AddressModule String IP address ID or IP address group ID.
    Id String id
    Desc String Description

    ProxyConfig

    Access proxy configuration.

    Used by actions: CreateClusters.

    Name Type Required Description
    ProxyCount Integer No Number of database proxy group nodes. this parameter is no longer recommended. recommend using ProxyZones.
    Cpu Integer No Number of CPU cores
    Mem Integer No Memory.
    ConnectionPoolType String No Connection pool type: SessionConnectionPool (session-level connection pool).
    OpenConnectionPool String No Whether to enable the connection pool. valid values: yes (enable), no (not enabled).
    ConnectionPoolTimeOut Integer No Connection pool threshold. measurement unit (seconds).
    Description String No Description.
    ProxyZones Array of ProxyZone No Database node information (this parameter is used in combination with ProxyCount, either one must be manually input).

    ProxyConfigInfo

    Access proxy configuration.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    ProxyCount Integer No Number of database proxy group nodes. this parameter is no longer recommended. recommend using ProxyZones.
    Cpu Integer No Number of CPU cores
    Mem Integer No Specifies the memory.
    Description String No Description.
    ProxyZones Array of ProxyZone No Database node information (this parameter is used in combination with ProxyCount, either one must be manually input).

    ProxyConnectionPoolInfo

    Connection pool information for the database proxy

    Used by actions: DescribeProxies.

    Name Type Required Description
    ConnectionPoolTimeOut Integer Yes Specifies the persistence threshold of the connection pool. the unit is seconds.
    OpenConnectionPool String No Whether the connection pool is enabled.
    ConnectionPoolType String No Specifies the connection pool type. valid values: SessionConnectionPool (session-level connection pool).

    ProxyEndPointConfigInfo

    proxy address configuration of the integrated cluster.

    Used by actions: CreateIntegrateCluster.

    Name Type Required Description
    UniqueVpcId String No Specifies the ID of the VPC network it belongs to.
    UniqueSubnetId String No Subnet ID.
    SecurityGroupIds Array of String No Security group id array.
    WeightMode String No Weight mode: system-system allocation, custom-custom.
    AutoAddRo String No Specifies whether to automatically add a read-only instance. valid values: yes, no.
    RwType String No Read-Write attribute. valid values: READWRITE, READONLY.
    InstanceNameWeights Array of InstanceNameWeight No Weight information.

    ProxyGroup

    Proxy group

    Used by actions: DescribeProxies.

    Name Type Description
    ProxyGroupId String Database proxy group ID
    ProxyNodeCount Integer Number of nodes in the proxy group
    Status String Database proxy group status
    Region String Region
    Zone String AZ
    CurrentProxyVersion String Current proxy version
    ClusterId String Cluster ID
    AppId Integer User AppId
    OpenRw String Specifies that a read-write node activates the database proxy.

    ProxyGroupInfo

    Database proxy group details

    Used by actions: DescribeProxies.

    Name Type Description
    ProxyGroup ProxyGroup Database proxy group.
    ProxyGroupRwInfo ProxyGroupRwInfo Database proxy group read-write separation information.
    ProxyNodes Array of ProxyNodeInfo Node information of the database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    ConnectionPool ProxyConnectionPoolInfo Database proxy connection pool information.
    NetAddrInfos Array of NetAddr Network information for database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    Tasks Array of ObjectTask Database proxy task set.

    ProxyGroupRwInfo

    Read/write separation information of the database proxy group

    Used by actions: DescribeProxies.

    Name Type Required Description
    ConsistencyType String No Consistency type. Valid values: eventual (eventual consistency), session (session consistency), global (global consistency).
    ConsistencyTimeOut Integer No Consistency timeout period
    WeightMode String No Weight mode. Valid values: system (auto-assigned), custom.
    FailOver String No Whether to enable failover
    AutoAddRo String No Whether to automatically add read-only instance. Valid value: yes, no.
    InstanceWeights Array of ProxyInstanceWeight No Instance weight array
    OpenRw String No Whether to enable read-write nodes. valid values: yes, no.
    RwType String No Read/write attribute. Valid values: READWRITE, READONLY.
    TransSplit Boolean No Transaction split
    AccessMode String No Connection mode. Valid values: balance, nearby.

    ProxyInstanceWeight

    Weight ratio between read-write instances and read-only instances

    Used by actions: CreateProxyEndPoint, DescribeProxies, ModifyProxyRwSplit.

    Name Type Required Description
    InstanceId String Yes InstanID
    Weight Integer Yes Instance weight

    ProxyNodeInfo

    Node in the database proxy group

    Used by actions: DescribeProxies, DescribeProxyNodes.

    Name Type Description
    ProxyNodeId String Database proxy node ID
    ProxyNodeConnections Integer Current node connections, which is not returned by the DescribeProxyNodes API.
    Cpu Integer CPU of the database proxy node
    Mem Integer Memory of the database proxy node
    Status String Status of the database proxy node
    ProxyGroupId String Database proxy group ID
    ClusterId String Cluster ID
    AppId Integer User AppID
    Region String Region
    Zone String AZ
    OssProxyNodeName String Database Proxy Node Name

    ProxySpec

    Database proxy specifications

    Used by actions: DescribeProxySpecs.

    Name Type Description
    Cpu Integer Number of database proxy CPU cores
    Mem Integer Database proxy memory

    ProxyVersionInfo

    The proxy version information supported by TDSQL-C for MySQL.

    Used by actions: DescribeSupportProxyVersion.

    Name Type Description
    ProxyVersion String proxy version number.
    ProxyVersionType String Version description: GA: stable version. BETA: BETA version. DEPRECATED: outdated.

    ProxyZone

    Number of proxy nodes and their AZs

    Used by actions: CreateClusters, CreateIntegrateCluster, CreateProxy, UpgradeProxy.

    Name Type Required Description
    ProxyNodeZone String No AZ of the proxy node
    ProxyNodeCount Integer No The number of proxy nodes

    QueryFilter

    Query filter

    Used by actions: DescribeClusters, DescribeInstances, DescribeIsolatedInstances, DescribeProxyNodes, DescribeTasks.

    Name Type Required Description
    Names Array of String Yes Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip"
    Values Array of String Yes Search string
    ExactMatch Boolean No Whether to use exact match
    Name String No Search field

    QueryParamFilter

    Filters for query

    Used by actions: DescribeProxies.

    Name Type Required Description
    Names Array of String Yes Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip"
    Values Array of String Yes Search string
    ExactMatch Boolean No Whether to use exact match

    ResourcePackage

    Information of a resource pack

    Used by actions: DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances.

    Name Type Required Description
    PackageId String No The unique ID of the resource package.
    PackageType String No Resource package type: CCU: compute resource package.
    DISK: storage resource package.
    DeductionPriority Integer No Deduction priority of the current resource package bound to the current instance.

    RollbackData

    Rollback Task Information

    Used by actions: DescribeTasks.

    Name Type Description
    Cpu Integer Instance CPU
    Memory Integer Instance Memory
    StorageLimit Integer Cluster storage limit
    OriginalClusterId String Original Cluster id
    OriginalClusterName String Original Cluster Name
    RollbackStrategy String Rollback Method
    SnapshotTime String Snapshot Time
    MinCpu Integer Minimum CPU when rolling back to a serverlessls cluster.
    MaxCpu Integer Maximum CPU when rolling back to a serverlessls cluster.
    SnapShotId Integer Snapshot ID.
    RollbackDatabases Array of RollbackDatabase Rollback Database
    RollbackTables Array of RollbackTable Rollback Data Table
    BackupFileName String Specifies the backup file name.
    RollbackProcess RollbackProcessInfo Rollback process.

    RollbackDatabase

    Rollback Database Information

    Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.

    Name Type Required Description
    OldDatabase String Yes Old Database Name
    NewDatabase String Yes New Database Name

    RollbackInstanceInfo

    Rollback Instance Information

    Used by actions: DescribeTasks.

    Name Type Description
    ClusterId String Cluster ID
    ClusterName String Cluster name.
    UniqVpcId String VPC information
    UniqSubnetId String Subnet information.
    Vip String vip information.
    Vport Integer Specifies the vport information.
    InstanceId String Instance ID
    InstanceName String Instance name
    Status String Status
    Cpu Integer CPU Size
    Mem Integer Memory Size
    StorageLimit Integer Storage size

    RollbackProcessInfo

    Rollback Progress Details

    Used by actions: DescribeTasks.

    Name Type Description
    IsVipSwitchable Boolean Is it possible to switch vip.
    VipSwitchableTime String The exchangeable time of vip.
    ExchangeInstanceInfoList Array of ExchangeInstanceInfo Exchange Instance List
    ExchangeRoGroupInfoList Array of ExchangeRoGroupInfo Swap RO Group List
    CurrentStep String Current step.
    CurrentStepProgress Integer Current step progress.
    CurrentStepRemainingTime String Remaining time of the current step.

    RollbackRoGroupInfo

    Rollback RO Group Information

    Used by actions: DescribeTasks.

    Name Type Description
    InstanceGroupId String Instance group ID
    UniqVpcId String VPC information
    UniqSubnetId String Subnet information.
    Vip String vip information.
    Vport Integer Specifies the vport information.

    RollbackTable

    Rollback Database and Tables

    Used by actions: DescribeTasks, RollBackCluster, RollbackToNewCluster.

    Name Type Required Description
    Database String Yes Database Name
    Tables Array of RollbackTableInfo Yes Database Table

    RollbackTableInfo

    Rollback Table Information

    Used by actions: RollBackCluster, RollbackToNewCluster.

    Name Type Required Description
    OldTable String Yes Old table name.
    NewTable String Yes New table name.

    RollbackTimeRange

    Rollback time range

    Used by actions: DescribeRollbackTimeRange.

    Name Type Description
    TimeRangeStart String Start time
    TimeRangeEnd String End time

    RuleFilters

    Filter of the audit rule

    Used by actions: CreateAuditRuleTemplate, DescribeAuditRuleTemplates, DescribeAuditRuleWithInstanceIds, ModifyAuditRuleTemplates, ModifyAuditService.

    Name Type Required Description
    Type String Yes Filter parameter name of the audit rule. Valid values: host (client IP), user (database account), dbName (database name), sqlType (SQL type), sql (SQL statement).
    Compare String Yes Filter match type of the audit rule. Valid values: INC (including), EXC (excluding), EQS (equal to), NEQ (not equal to).
    Value Array of String Yes Filter match value of the audit rule

    RuleTemplateInfo

    Rule Template Content

    Used by actions: DescribeAuditRuleWithInstanceIds.

    Name Type Description
    RuleTemplateId String Rule template ID.
    RuleTemplateName String Rule template name.
    RuleFilters Array of RuleFilters The rule content.
    AlarmLevel Integer Alarm level. valid values: 1 (low risk), 2 (medium risk), 3 (high risk).
    AlarmPolicy Integer Alarm policy. 0 - no alert, 1 - alert.
    Description String Rule description.

    SalePackageSpec

    Resource pack details

    Used by actions: DescribeResourcePackageSaleSpec.

    Name Type Description
    PackageRegion String Resource package region of use.
    PackageType String Specifies the resource package type.
    CCU - compute resource package.
    Storage resource package.
    PackageVersion String Resource pack version.
    base - basic version; common - general version; enterprise - enterprise edition.
    MinPackageSpec Float Minimum number of resources in the current version of the resource package. compute resource unit: pieces; storage resource: GB.
    MaxPackageSpec Float Specifies the maximum number of resources in the current version of the resource package. valid values: compute resource unit: pieces; storage resource: GB.
    ExpireDay Integer Specifies the resource pack validity period. the measurement unit is day.

    SaleRegion

    Information of a purchasable region

    Used by actions: DescribeZones.

    Name Type Description
    Region String Region name
    RegionId Integer Numeric ID of a region
    RegionZh String Region name
    ZoneSet Array of SaleZone List of purchasable AZs
    DbType String Engine type
    Modules Array of Module Supported modules in a region

    SaleZone

    Information of a purchasable AZ

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ name
    ZoneId Integer Numeric ID of an AZ
    ZoneZh String AZ name
    IsSupportServerless Integer Whether serverless cluster is supported. Valid values:

    0: No

    1: Yes
    IsSupportNormal Integer Whether standard cluster is supported. Valid values:

    0: No

    1: Yes
    PhysicalZone String Physical zone
    HasPermission Boolean Whether the user has AZ permission.
    IsWholeRdmaZone String Whether it is a full-linkage RDMA AZ.
    IsSupportCreateCluster Integer Specifies whether a newly purchased cluster is allowed in the current availability zone. valid values: 1 (allowed), 0 (not allowed).

    SecurityGroup

    Security group details

    Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

    Name Type Description
    ProjectId Integer Project ID
    CreateTime String Creation time in the format of yyyy-mm-dd hh:mm:ss
    Inbound Array of PolicyRule Inbound rule
    Outbound Array of PolicyRule Outbound rule
    SecurityGroupId String Security group ID
    SecurityGroupName String Security group name
    SecurityGroupRemark String Security group remarks

    ServerlessSpec

    serverless specification.

    Used by actions: DescribeServerlessInstanceSpecs.

    Name Type Description
    MinCpu Float Specifies the minimum value of the cpu.
    MaxCpu Float Maximum value of cpu.
    MaxStorageSize Integer Maximum storage space.
    IsDefault Integer Specifies whether it is the default specification.
    HasStock Boolean Whether there is inventory.
    StockCount Integer Inventory quantity.
    ZoneStockInfos Array of ServerlessZoneStockInfo Availability zone inventory information.
    Note: This field may return null, indicating that no valid values can be obtained.

    ServerlessZoneStockInfo

    serverless type availability zone inventory information.

    Used by actions: DescribeServerlessInstanceSpecs.

    Name Type Description
    Zone String Availability zone
    StockCount Integer Specifies the stored amount.
    HasStock Boolean Whether it contains inventory.
    SlaveZoneStockInfos Array of SlaveZoneStockInfo Inventory information from availability zone.

    SlaveZoneAttrItem

    AZ Attribute Item

    Used by actions: DescribeClusterDetail, DescribeTasks.

    Name Type Description
    Zone String Availability zone
    BinlogSyncWay String binlog synchronization mode.
    SemiSyncTimeout Integer Semi-Sync timeout period in milliseconds.

    SlaveZoneStockInfo

    Secondary AZ Inventory Information

    Used by actions: DescribeInstanceSpecs, DescribeServerlessInstanceSpecs.

    Name Type Description
    SlaveZone String Replica AZ.
    StockCount Integer Inventory quantity in spare availability zone.
    HasStock Boolean Whether there is inventory in the spare availability zone.

    SlowQueriesItem

    Slow query information of the instance

    Used by actions: DescribeInstanceSlowQueries.

    Name Type Description
    Timestamp Integer Execution timestamp
    QueryTime Float Execution duration in seconds
    SqlText String SQL statement
    UserHost String Client host
    UserName String Username
    Database String Database name
    LockTime Float Lock duration in seconds
    RowsExamined Integer Number of scanned rows
    RowsSent Integer Number of returned rows
    SqlTemplate String SQL template
    SqlMd5 String MD5 value of the SQL statement
    SyncReadCountRemote Integer Remote reading count.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncReadBytesRemote Integer Number of remote read bytes.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncReadTimeRemote Integer Time spent on remote reads (µs).
    Specifies that the database kernel version is larger than 3.1.12.
    SyncWriteCountRemote Integer Remote write count.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncWriteBytesRemote Integer Specifies the number of remote written bytes.
    Specifies that the database kernel version is larger than 3.1.12.
    SyncWriteTimeRemote Integer Time spent on remote writing (µs).
    Specifies that the database kernel version is larger than 3.1.12.
    TrxCommitDelay Integer Transaction submission delay (µs).
    Specifies that the database kernel version is larger than 3.1.12.

    SwitchClusterLogBin

    Toggle Cluster log bin Switch

    Used by actions: DescribeTasks.

    Name Type Description
    Status String Status

    TablePrivileges

    MySQL table permission

    Used by actions: ModifyAccountPrivileges.

    Name Type Required Description
    Db String Yes Database name
    TableName String Yes Table name
    Privileges Array of String Yes Permission list

    Tag

    Information of tags associated with cluster, including TagKey and TagValue

    Used by actions: CreateClusters, CreateIntegrateCluster, DescribeAuditInstanceList, DescribeClusterDetail, DescribeClusters, DescribeInstances, DescribeIsolatedInstances, RollbackToNewCluster.

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

    TaskMaintainInfo

    TaskMaintainInfo

    Used by actions: DescribeTasks.

    Name Type Description
    MaintainStartTime Integer Execution start time (seconds from 0 o'clock).
    MaintainDuration Integer Specifies the continuous time. the unit is second.
    MaintainWeekDays Array of String Specifies the time when it can be executed. valid values: ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"].

    TaskProgressInfo

    Task progress query.

    Used by actions: DescribeTasks.

    Name Type Description
    CurrentStep String Current step.
    CurrentStepProgress Integer Current progress.
    CurrentStepRemainingTime String Estimated Time

    TemplateParamInfo

    Parameter template details

    Used by actions: DescribeParamTemplates.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String The collection of optional value types when the parameter type is enum.
    Max String The maximum value when the parameter type is float/integer.
    Min String Minimum value when the parameter type is float/integer.
    ParamName String Parameter name
    NeedReboot Integer Whether to restart the instance for the parameter to take effect
    Description String Parameter description
    ParamType String Parameter type. Valid value: integer, float, string, enum.

    TradePrice

    Billing details

    Used by actions: InquirePriceCreate, InquirePriceModify, InquirePriceMultiSpec, InquirePriceRenew.

    Name Type Description
    TotalPrice Integer Resource total price under prepaid mode, excluding discounts. unit: microCent. 1 US dollar equals 1e8 microCents.
    Discount Float Total discount. 100 means no discount.
    TotalPriceDiscount Integer Discounted total price under prepaid mode, unit: cent. 1 US dollar equals 1e8 microCents. for example, the user enjoys a Discount = TotalPrice * Discount.
    UnitPrice Integer Unit resource price in postpaid mode, excluding discounts. unit: cent. 1 US dollar equals 1e2 cents
    UnitPriceDiscount Integer Unit resource price in postpaid mode after Discount, unit: cent. 1 US dollar equals 1e2 cents. for example, the user enjoys a Discount = unitprice * Discount.
    ChargeUnit String Price unit
    UnitPriceHighPrecision String Excludes discounted rates under high precision.
    UnitPriceDiscountHighPrecision String Discounted price under high precision.
    AmountUnit String Currency unit.

    UserHostPrivilege

    User host permissions

    Used by actions: CreateClusterDatabase, DescribeClusterDetailDatabases, ModifyClusterDatabase.

    Name Type Required Description
    DbUserName String Yes Authorized user
    DbHost String Yes Client IP
    DbPrivilege String Yes User permission

    ZoneStockInfo

    Inventory information in an AZ

    Used by actions: DescribeInstanceSpecs.

    Name Type Description
    Zone String AZ
    HasStock Boolean Whether there is an inventory.
    StockCount Integer Quantity in stock
    SlaveZoneStockInfos Array of SlaveZoneStockInfo Available zone inventory information.
    Topik sebelumnya: ExportInstanceErrorLogsTopik selanjutnya: Error Codes

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan