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

Data Types

포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-02-27 17:45:53

AdvancedRetentionPolicy

Retention policy for scheduled snapshots. All four parameters are required.

Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy.

Name Type Required Description
Days Integer Yes Retains one latest snapshot each day within Days days. Value range: [0, 100].
Note: This field may return null, indicating that no valid values can be obtained.
Weeks Integer Yes Retains one latest snapshot each week within Weeks weeks. Value range: [0, 100].
Note: This field may return null, indicating that no valid values can be obtained.
Months Integer Yes Retains one latest snapshot each month within Months months. Value range: [0, 100].
Note: This field may return null, indicating that no valid values can be obtained.
Years Integer Yes Retains one latest snapshot each year within Years years. Value range: [0, 100].
Note: This field may return null, indicating that no valid values can be obtained.

AttachDetail

This describes the number of mounted and mountable data disks of an instance.

Used by actions: DescribeInstancesDiskNum.

Name Type Description
InstanceId String Instance ID
AttachedDiskCount Integer The number of instances mounted to data disk.
MaxAttachCount Integer The maximum number of instances that can be mounted to data disk.

AutoMountConfiguration

Describes how a newly purchased cloud disk is initialized and attached to a CVM instance.

Used by actions: CreateDisks.

Name Type Required Description
InstanceId Array of String Yes ID of the instance to which the cloud disk is attached.
MountPoint Array of String Yes Mount point in the instance.
FileSystemType String Yes File system type. Valid values: ext4, xfs.

AutoSnapshotPolicy

This describes the detailed information of the scheduled snapshot policy.

Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy.

Name Type Description
DiskIdSet Array of String The list of cloud disk IDs that the current scheduled snapshot policy is bound to.
IsActivated Boolean Whether scheduled snapshot policy is activated.
AutoSnapshotPolicyState String Scheduled snapshot policy state. Value range:
  • NORMAL: Normal
  • ISOLATED: Isolated.
  • IsCopyToRemote Integer Whether it is to replicate a snapshot across accounts. 1: yes, 0: no.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsPermanent Boolean Whether the snapshot created by this scheduled snapshot policy is retained permanently.
    NextTriggerTime Timestamp The time the scheduled snapshot will be triggered again.
    AutoSnapshotPolicyName String Scheduled snapshot policy name.
    AutoSnapshotPolicyId String Scheduled snapshot policy ID.
    Policy Array of Policy The policy for executing the scheduled snapshot.
    CreateTime Timestamp The time the scheduled snapshot policy was created.
    RetentionDays Integer Number of days the snapshot created by this scheduled snapshot policy is retained.
    CopyToAccountUin String ID of the replication target account
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceIdSet Array of String List of IDs of the instances associated with the scheduled snapshot policy.
    Note: This field may return null, indicating that no valid values can be obtained.
    RetentionMonths Integer The number of months for which the snapshots created by this scheduled snapshot policy can be retained.
    Note: This field may return null, indicating that no valid values can be obtained.
    RetentionAmount Integer The maximum number of snapshots created by this scheduled snapshot policy that can be retained.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdvancedRetentionPolicy AdvancedRetentionPolicy Retention policy for scheduled snapshots.
    Note: This field may return null, indicating that no valid values can be obtained.
    CopyFromAccountUin String Source account ID of the copied snapshot policy
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of Tag Tag.
    Note: This field may return null, indicating that no valid values can be obtained.

    DetailPrice

    Pricing details for the cloud disk.

    Used by actions: InquiryPriceResizeDisk.

    Name Type Description
    PriceTitle String Name of the billable item.
    Note: This field may return null, indicating that no valid values can be obtained.
    PriceName String Name of the billable item displayed in the console.
    OriginalPrice Float Original price of a monthly subscribed cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiscountPrice Float Discounted price of a monthly subscribed cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPrice Float Original unit price of a pay-as-you-go cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscount Float Discount unit price of a pay-as-you-go cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    ChargeUnit String Billing unit for pay-as-you-go cloud disks. Valid value: HOUR (billed hourly).
    Note: This field may return null, indicating that no valid values can be obtained.
    OriginalPriceHigh String Original highly-precise price of a monthly subscribed cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiscountPriceHigh String Discounted highly-precise price of a monthly subscribed cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPriceHigh String Original highly-precise unit price of a pay-as-you-go cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscountHigh String Discounted highly-precise unit price of a pay-as-you-go cloud disk, in USD.
    Note: This field may return null, indicating that no valid values can be obtained.

    Disk

    The details of a cloud disk

    Used by actions: DescribeDisks.

    Name Type Description
    DeleteWithInstance Boolean Whether the cloud disk terminates along with the instance mounted to it.
  • true: Cloud disk will also be terminated when instance terminates, so only hourly postpaid cloud disk are supported.
  • false: Cloud disk does not terminate when instance terminates.
    Note: This field may return null, indicating that no valid value was found.
  • RenewFlag String Auto renewal flag. Supported values:
  • NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically
  • NOTIFY_AND_MANUAL_RENEW: Notify expiry but not renew automatically
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically.
    Note: This field may return null, indicating that no valid value was found.
  • DiskType String Cloud disk types. Valid values:
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: Premium Cloud Disk
  • CLOUD_BSSD: General Purpose SSD
  • CLOUD_SSD: SSD
  • CLOUD_HSSD: Enhanced SSD
  • CLOUD_TSSD: Tremendous SSD
  • DiskState String The state of the cloud disk. Value range:
  • UNATTACHED: Not mounted
  • ATTACHING: Mounting
  • ATTACHED: Mounted
  • DETACHING: Un-mounting
  • EXPANDING: Expanding
  • ROLLBACKING: Rolling back
  • TORECYCE: Pending recycling.
  • DUMPING: Copying the hard drive.
  • SnapshotCount Integer The total number of snapshots of the cloud disk.
    AutoRenewFlagError Boolean Cloud disk already mounted to CVM, and both CVM and cloud disk use monthly subscription.
  • true: CVM has auto-renewal flag set up, but cloud disk does not.
  • false: Cloud disk auto-renewal flag set up normally.
    Note: This field may return null, indicating that no valid value was found.
  • Rollbacking Boolean Whether the cloud disk is in the status of snapshot rollback. Value range:
  • false: No
  • true: Yes
  • InstanceIdList Array of String For non-shareable cloud disks, this parameter is null. For shareable cloud disks, this parameters indicates this cloud disk's Instance IDs currently mounted to the CVM.
    Encrypt Boolean Whether the cloud disk is encrypted. Value range:
  • false: Not encrypted
  • true: Encrypted.
  • DiskName String Cloud disk name.
    BackupDisk Boolean Specifies whether to create a snapshot when the cloud disk is terminated due to overdue payment or expiration. true: create snapshot; false: do not create snapshot.
    Tags Array of Tag The tag bound to the cloud disk. The value Null is used when no tag is bound to the cloud disk.
    Note: This field may return null, indicating that no valid value was found.
    InstanceId String ID of the CVM to which the cloud disk is mounted.
    AttachMode String Cloud disk mount method. Valid values:
  • PF: mount as a PF (Physical Function)
  • VF: mount as a VF (Virtual Function)
    Note: this field may return null, indicating that no valid value is obtained.
  • AutoSnapshotPolicyIds Array of String ID of the periodic snapshot associated to the cloud disk. This parameter is returned only if the value of parameter ReturnBindAutoSnapshotPolicy is TRUE when the API DescribeDisks is called.
    Note: This field may return null, indicating that no valid value was found.
    ThroughputPerformance Integer Extra performance for a cloud disk, in MB/sec.
    Note: this field may return null, indicating that no valid values can be obtained.
    Migrating Boolean Whether cloud disk is in process of type change. Value range:
  • false: Cloud disk not in process of type change.
  • true: Cloud disk type change has been launched, and migration is in process.
    Note: This field may return null, indicating that no valid value was found.
  • DiskId String Cloud disk ID.
    SnapshotSize Integer The total capacity of the snapshots of the cloud disk. Unit: MB.
    Placement Placement Location of the cloud disk.
    IsReturnable Boolean Determines whether or not prepaid cloud disk supports active return.
  • true: Active return supported.
  • false: Active return not supported.
    Note: This field may return null, indicating that no valid value was found.
  • DeadlineTime Timestamp Expiration time of the cloud disk.
    Attached Boolean Whether the cloud disk is mounted to the CVM. Value range:
  • false: Unmounted
  • true: Mounted.
  • DiskSize Integer Cloud disk size (in GB).
    MigratePercent Integer Migration progress of cloud disk type change, from 0 to 100.
    Note: This field may return null, indicating that no valid value was found.
    DiskUsage String Cloud disk type. Value range:
  • SYSTEM_DISK: System disk
  • DATA_DISK: Data disk.
  • DiskChargeType String Billing method. Value range:
  • PREPAID: Prepaid, that is, monthly subscription
  • POSTPAID_BY_HOUR: Postpaid, that is, pay as you go.
  • Portable Boolean Whether it is an elastic cloud disk. false: Non-elastic cloud disk; true: Elastic cloud disk.
    SnapshotAbility Boolean Whether the cloud disk has the capability to create snapshots. Value range:
  • false: Cannot create snapshots. true: Can create snapshots.
  • DeadlineError Boolean This field is only applicable when the instance is already mounted to the cloud disk, and both the instance and the cloud disk use monthly subscription.
  • true: Expiration time of cloud disk is earlier than that of the instance.
  • false:Expiration time of cloud disk is later than that of the instance.
    Note: This field may return null, indicating that no valid value was found.
  • RollbackPercent Integer Rollback progress of a cloud disk snapshot.
    DifferDaysOfDeadline Integer Number of days from current time until disk expiration (only applicable for prepaid disks).
    Note: This field may return null, indicating that no valid value was found.
    ReturnFailCode Integer In circumstances where the prepaid cloud disk does not support active return, this parameter indicates the reason that return is not supported. Value range:
  • 1: The cloud disk has already been returned.
  • 2: The cloud disk has already expired.
  • 3: The cloud disk does not support return.
  • 8: The limit on the number of returns is exceeded.
    Note: This field may return null, indicating that no valid value was found.
  • Shareable Boolean Whether or not cloud disk is shareable cloud disk.
    CreateTime Timestamp Creation time of the cloud disk.
    DeleteSnapshot Integer Delete the associated non-permanently reserved snapshots upon deletion of the source cloud disk. 0: No (default). 1: Yes. To check whether a snapshot is permanently reserved, refer to the IsPermanent field returned by the DescribeSnapshots API.
    DiskBackupQuota Integer Quota of cloud disk backup points, i.e., the maximum number of backup points that a cloud disk can have.
    DiskBackupCount Integer Number of used cloud disk backups.
    InstanceType String Type of the instance mounted to the cloud disk. Valid values:
  • CVM
  • EKS
  • LastAttachInsId String ID of the last instance to which the cloud disk is attached
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrorPrompt String Error message for the last operation of the cloud disk
    Note: This field may return null, indicating that no valid values can be obtained.
    BurstPerformance Boolean Whether the cloud disk has enabled disk bursting. Note: This field may return null, indicating that no valid values can be obtained.

    DiskBackup

    Cloud disk backup point.

    Used by actions: DescribeDiskBackups.

    Name Type Description
    DiskBackupId String Cloud disk backup point ID.
    DiskId String ID of the cloud disk with which the backup point is associated.
    DiskSize Integer Cloud disk size in GB.
    DiskUsage String Cloud disk type. Valid values:
  • SYSTEM_DISK: System disk
  • DATA_DISK: Data disk
  • DiskBackupName String Backup point name.
    DiskBackupState String Cloud disk backup point status. Valid values:
  • NORMAL: Normal
  • CREATING: Creating
  • ROLLBACKING: Rolling back
  • Percent Integer Cloud disk creation progress in percentage.
    CreateTime Timestamp ISO8601 Creation time of the cloud disk backup point.
    Encrypt Boolean Whether the cloud disk is encrypted. Valid values:
  • false: Not encrypted
  • true: Encrypted
  • DiskChargePrepaid

    Billing mode of the instance

    Used by actions: CreateDisks, InquiryPriceCreateDisks, RenewDisk.

    Name Type Required Description
    Period Integer Yes Specifies the duration for purchasing cloud block storage (cbs) in months. default unit: month. valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    RenewFlag String No Automatic renewal flag. valid values:.

    • NOTIFY_AND_AUTO_RENEW: notifies expiry and renews automatically.
    • .
    • NOTIFY_AND_MANUAL_RENEW: notifies expiry but does not renew automatically.
    • .
    • DISABLE_NOTIFY_AND_MANUAL_RENEW: no notification is sent upon expiration, and the instance is not renewed automatically.
    • .

    Default value: NOTIFY_AND_MANUAL_RENEW.
    CurInstanceDeadline Timestamp No Specifies the current expiration time of the child machine when the expiration time of the cloud block storage needs to align with the mounted child machine. you can input this parameter. if Period is input at this time, it indicates the duration of child machine renewal. the cloud disk will automatically renew according to the expiration time after the child machine is renewed.

    DiskConfig

    Cloud disk configuration.

    Used by actions: DescribeDiskConfigQuota.

    Name Type Description
    Available Boolean Whether the configuration is available.
    DiskChargeType String Billing method. Value range:
  • PREPAID: Prepaid, that is, monthly subscription
  • POSTPAID_BY_HOUR: Postpaid, that is, pay as you go.
  • Zone String The Availability Region of the cloud drive.
    InstanceFamily String Instance model series. For more information, please see Instance Models
    Note: This field may return null, indicating that no valid value was found.
    DiskType String Type of cloud disk medium. Value range:
  • CLOUD_BASIC: Ordinary cloud disk
  • CLOUD_PREMIUM: Premium cloud storage
  • CLOUD_SSD: SSD cloud disk.
  • StepSize Integer Minimum increment of cloud disk size adjustment in GB.
    Note: This field might return null, indicating that no valid values can be obtained.
    ExtraPerformanceRange Array of Integer Additional performance range.
    Note: This field might return null, indicating that no valid values can be obtained.
    DeviceClass String Instance model.
    Note: This field may return null, indicating that no valid value was found.
    DiskUsage String Cloud disk type. Value range:
  • SYSTEM_DISK: System disk
  • DATA_DISK: Data disk.
  • MinDiskSize Integer The minimum configurable cloud disk size (in GB).
    MaxDiskSize Integer The maximum configurable cloud disk size (in GB).
    Price Price Price of a monthly subscribed or pay-as-you-go cloud disk.
    Note: This field may return null, indicating that no valid values can be obtained.

    DiskOperationLog

    The operation log of the cloud disk.

    Used by actions: DescribeDiskOperationLogs.

    Name Type Description
    Operator String UIN of operator.
    Operation String Operation type. Value range:
    CBS_OPERATION_ATTACH: Mount cloud disk
    CBS_OPERATION_DETACH: Unmount cloud disk
    CBS_OPERATION_RENEW: Renew
    CBS_OPERATION_EXPAND: Expand
    CBS_OPERATION_CREATE: Create
    CBS_OPERATION_ISOLATE: Isolate
    CBS_OPERATION_MODIFY: Modify cloud disk attributes
    ASP_OPERATION_BIND: Associate scheduled snapshot policy
    ASP_OPERATION_UNBIND: Cancel associated scheduled snapshot policy
    DiskId String Cloud disk ID of operation.
    OperationState String Status of operation. Value range:
    SUCCESS: Operation successful
    FAILED: Operation failed
    PROCESSING: Operation in process
    StartTime String Start time
    EndTime String End time

    Filter

    Key-value pair filters for conditional filtering queries.

    Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskBackups, DescribeDiskOperationLogs, DescribeDisks, DescribeSnapshotOperationLogs, DescribeSnapshots.

    Name Type Required Description
    Name String Yes Name of filter key.
    Values Array of String Yes One or more filter values.

    Image

    Image

    Used by actions: DescribeSnapshots.

    Name Type Description
    ImageId String Image instance ID.
    ImageName String Image name.

    Placement

    This describes the abstract location of the instance, including the availability zone in which it is located, the projects to which it belongs, and the ID and name of the dedicated clusters to which it belongs.

    Used by actions: CreateDisks, DescribeDisks, DescribeSnapshots.

    Name Type Required Description
    Zone String Yes The ID of the Availability Zone to which the cloud disk belongs. This parameter can be obtained from the Zone field in the returned values of DescribeZones.
    CageId String No Cage ID. When it is an input parameter, the specified CageID resource is operated, and it can be left blank. When it is an output parameter, it is the ID of the cage the resource belongs to, and it can be left blank.
    Note: This field may return null, indicating that no valid value was found.
    ProjectId Integer No ID of the project to which the instance belongs. This parameter can be obtained from the projectId field in the returned values of DescribeProject. If this is left empty, default project is used.
    ProjectName String No Project name of the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    CdcName String No Dedicated cluster name. When it is an input parameter, it is ignored. When it is an output parameter, it is the name of the dedicated cluster the cloud disk belongs to, and it can be left blank.
    Note: This field may return null, indicating that no valid value was found.
    CdcId String No ID of dedicated cluster which the instance belongs to. When it is an input parameter, the specified CdcId dedicated cluster resource is operated, and it can be left blank. When it is an output parameter, it is the ID of the dedicated cluster which the resource belongs to, and it can be left blank.
    Note: This field may return null, indicating that no valid value was found.
    DedicatedClusterId String No Dedicated cluster ID

    Policy

    Execution policy for scheduled snapshot. It indicates that a scheduled snapshot policy is executed at the specified Hour in the days specified by DayOfWeek or DayOfMonth or once every IntervalDays days. Note: DayOfWeek, DayOfMonth, and IntervalDays are mutually exclusive, and only one policy rule can be set.

    Used by actions: CreateAutoSnapshotPolicy, DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy, ModifyAutoSnapshotPolicyAttribute.

    Name Type Required Description
    Hour Array of Integer Yes Specifies the time that that the scheduled snapshot policy will be triggered. The unit is hour. The value range is [0-23]. 00:00-23:00 is a total of 24 time points that can be selected. 1 indicates 01:00, and so on.
    DayOfWeek Array of Integer No Specifies the days of the week, from Monday to Sunday, on which a scheduled snapshot will be triggered. Value range: [0, 6]. 0 indicates triggering on Sunday, 1-6 indicate triggering on Monday-Saturday.
    DayOfMonth Array of Integer No Specifies the dates of the month on which a scheduled snapshot will be triggered. Value range: [1, 31]. 1 to 31 indicate the specific dates of the month; for example, 5 indicates the 5th day of the month. Note: If you set a date that does not exist in some months such as 29, 30, and 31, these months will be skipped for scheduled snapshot creation.
    IntervalDays Integer No Specifies the interval for creating scheduled snapshots in days. Value range: [1, 365]. For example, if it is set to 5, scheduled snapshots will be created every 5 days. Note: If you choose to back up by day, the time for the first backup is theoretically the day when the backup policy is created. If the backup policy creation time on the current day is later than the set backup time, the first backup will be performed in the second backup cycle.

    PrepayPrice

    The cost of a prepaid order.

    Used by actions: InquiryPriceResizeDisk.

    Name Type Description
    DiscountPrice Float Discounted price of a monthly-subscribed cloud disk or a snapshot, in USD.
    ChargeUnit String Billing unit for pay-as-you-go cloud disks. Valid value:
  • HOUR: billed hourly.
    Note: this field may return null, indicating that no valid values can be obtained.
  • UnitPriceHigh String Original unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginalPriceHigh String Original payment of a monthly-subscribed cloud disk or a snapshot, in USD, with six decimal places.
    OriginalPrice Float Original payment of a monthly-subscribed cloud disk or a snapshot, in USD.
    UnitPriceDiscount Float Discount unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscountHigh String Discounted unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountPriceHigh String Discounted price of a monthly-subscribed cloud disk or a snapshot, in USD, with six decimal places.
    UnitPrice Float Original unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    DetailPrices Array of DetailPrice Detailed billing items
    Note: This field may return null, indicating that no valid values can be obtained.

    Price

    Describes the prepaid or postpaid price for the cloud disk.

    Used by actions: DescribeDiskConfigQuota, InquirePriceModifyDiskBackupQuota, InquirePriceModifyDiskExtraPerformance, InquiryPriceCreateDisks.

    Name Type Description
    UnitPriceDiscount Float Discount unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountPrice Float Discounted price of a monthly-subscribed cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPrice Float Original unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceHigh String Original unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginalPriceHigh String Original payment of a monthly-subscribed cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginalPrice Float Original price of a monthly-subscribed cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountPriceHigh String Discounted payment price of a monthly-subscribed cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscountHigh String Discounted unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    ChargeUnit String Billing unit for postpaid cloud disk. valid values:
  • HOUR: the billing unit for postpaid cloud disk is calculated hourly.
  • .
    Note: This field may return null, indicating that no valid values can be obtained.

    SharePermission

    Snapshot sharing information set

    Used by actions: DescribeSnapshotSharePermission.

    Name Type Description
    CreatedTime Timestamp Snapshot sharing time
    AccountId String ID of the shared account

    Snapshot

    The details of a snapshot

    Used by actions: DescribeSnapshots.

    Name Type Description
    Placement Placement Location of the snapshot.
    CopyFromRemote Boolean Whether the snapshot is replicated across regions. Value range:
  • true: Indicates that the snapshot is replicated across regions.
  • false: Indicates that the snapshot belongs to the local region.
  • SnapshotState String Snapshot status. Valid values:
  • NORMAL: normal
  • CREATING: creating
  • ROLLBACKING: rolling back
  • COPYING_FROM_REMOTE: cross-region replicating
  • CHECKING_COPIED: verifying the cross-region replicated data
  • TORECYCLE: to be repossessed.
  • IsPermanent Boolean Whether it is a permanent snapshot. Value range:
  • true: Permanent snapshot
  • false: Non-permanent snapshot.
  • SnapshotName String Snapshot name, the user-defined snapshot alias. Call ModifySnapshotAttribute to modify this field.
    DeadlineTime Timestamp The expiration time of the snapshot. If the snapshot is permanently retained, this field is blank.
    Percent Integer The progress percentage for snapshot creation. This field is always 100 after the snapshot is created successfully.
    Images Array of Image List of images associated with snapshot.
    ShareReference Integer Number of snapshots currently shared
    SnapshotType String Snapshot type. This value can currently be either PRIVATE_SNAPSHOT or SHARED_SNAPSHOT.
    DiskSize Integer Size of the cloud disk used to create this snapshot (in GB).
    DiskId String ID of the cloud disk used to create this snapshot.
    CopyingToRegions Array of String The destination region to which the snapshot is being replicated. Default value is [ ].
    Encrypt Boolean Whether the snapshot is created from an encrypted disk. Value range:
  • true: Yes
  • false: No.
  • CreateTime Timestamp Creation time of the snapshot.
    ImageCount Integer Number of images associated with snapshot.
    DiskUsage String The type of the cloud disk used to create the snapshot. Value range:
  • SYSTEM_DISK: System disk
  • DATA_DISK: Data disk.
  • SnapshotId String Snapshot ID.
    TimeStartShare Date The time when the snapshot sharing starts
    Tags Array of Tag List of tags associated with the snapshot.

    SnapshotCopyResult

    Result of the cross-region replication task

    Used by actions: CopySnapshotCrossRegions.

    Name Type Description
    SnapshotId String ID of the snapshot replica
    Message String Error message. It’s null if the request succeeds.
    Code String Error code. It’s Success if the request succeeds.
    DestinationRegion String Destination region of the replication task

    SnapshotOperationLog

    Snapshot operation log (disused).

    Used by actions: DescribeSnapshotOperationLogs.

    Name Type Description
    OperationState String Status of operation. Value range:
    SUCCESS: Operation successful
    FAILED: Operation failed
    PROCESSING: Operation in process
    StartTime String Start time
    Operator String UIN of operator.
    Note: This field may return null, indicating that no valid value was found.
    SnapshotId String ID of snapshot being operated.
    Operation String Operation type. Value range:
    SNAP_OPERATION_DELETE: Delete snapshot
    SNAP_OPERATION_ROLLBACK: Roll back snapshot
    SNAP_OPERATION_MODIFY: Modify snapshot attributes
    SNAP_OPERATION_CREATE: Create snapshot
    SNAP_OPERATION_COPY: Cross-region replication of snapshot
    ASP_OPERATION_CREATE_SNAP: Create snapshot with scheduled snapshot policy
    ASP_OPERATION_DELETE_SNAP: Delete snapshot from scheduled snapshot policy
    EndTime String End time

    Tag

    Tag.

    Used by actions: CreateDisks, CreateSnapshot, DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy, DescribeDisks, DescribeSnapshots.

    Name Type Required Description
    Key String Yes Tag key.
    Value String Yes Tag value.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백