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
DocumentaçãoAPIsTencent Cloud LighthouseData Types

Data Types

Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-26 22:26:36

AttachDetail

Attachment information

Used by actions: DescribeInstancesDiskNum.

Name Type Description
InstanceId String Instance ID
AttachedDiskCount Integer Number of elastic cloud disks attached to the instance
MaxAttachCount Integer Upper limit of attached elastic cloud disks

AutoMountConfiguration

Automatically attach and initialize the data disk.

Used by actions: CreateDisks.

Name Type Required Description
InstanceId String Yes ID of the instance to be mounted to. The instance must be Running.
MountPoint String No The mount point within the instance. Only Linux instances are supported. If it's not specified, the default mount point is "/data/disk".
FileSystemType String No The file system type. Values: ext4 (default) and xfs. Only Linux instances are supported.

Blueprint

Image information.

Used by actions: DescribeBlueprintInstances, DescribeBlueprints, DescribeResetInstanceBlueprints.

Name Type Description
BlueprintId String Image ID, which is the unique identifier of Blueprint.
DisplayTitle String Image title to be displayed.
DisplayVersion String Image version to be displayed.
Description String Image description information.
Note: This field may return null, indicating that no valid values can be obtained.
OsName String OS name.
Platform String OS type.
PlatformType String OS type, such as LINUX_UNIX and WINDOWS.
BlueprintType String Image type, such as APP_OS, PURE_OS, and PRIVATE.
ImageUrl String Image picture URL.
RequiredSystemDiskSize Integer System disk size required by image in GB.
BlueprintState String Image status.
CreatedTime Timestamp ISO8601 Creation time according to ISO 8601 standard. UTC time is used.
Format: YYYY-MM-DDThh:mm:ssZ.
Note: this field may return null, indicating that no valid values can be obtained.
BlueprintName String Image name.
SupportAutomationTools Boolean Whether the image supports automation tools.
RequiredMemorySize Integer Memory size required by image in GB.
ImageId String ID of the Lighthouse image shared from a CVM image
Note: this field may return null, indicating that no valid values can be obtained.
CommunityUrl String URL of official website of the open-source project
GuideUrl String Guide documentation URL
SceneIdSet Array of String Array of IDs of scenes associated with an image
Note: This field may return null, indicating that no valid values can be obtained.
DockerVersion String Docker version.
Note: This field may return null, indicating that no valid values can be obtained.

BlueprintInstance

Image instance information.

Used by actions: DescribeBlueprintInstances.

Name Type Description
Blueprint Blueprint Image information.
SoftwareSet Array of Software Software list.
InstanceId String Instance ID.

BlueprintPrice

BlueprintPrice Custom image price parameter.

Used by actions: InquirePriceCreateBlueprint.

Name Type Description
OriginalBlueprintPrice Float Original image unit price in USD.
OriginalPrice Float Original image total price in USD.
Discount Integer Discount.
DiscountPrice Float Discounted image total price in USD.

Bundle

Package information.

Used by actions: DescribeBundles, DescribeModifyInstanceBundles.

Name Type Description
BundleId String Package ID.
Memory Integer Memory size in GB.
SystemDiskType String System disk type.
Values:
  • CLOUD_SSD: SSD cloud disks
  • CLOUD_PREMIUM: Premium cloud disks
    		•
    SystemDiskSize Integer System disk size in GB.
    MonthlyTraffic Integer Monthly network traffic in GB.
    SupportLinuxUnixPlatform Boolean Whether Linux/Unix is supported.
    SupportWindowsPlatform Boolean Whether Windows is supported.
    Price Price Current package unit price information.
    CPU Integer Number of CPU cores.
    InternetMaxBandwidthOut Integer Peak bandwidth in Mbps.
    InternetChargeType String Network billing mode.
    BundleSalesState String Package sale status. Valid values: AVAILABLE, SOLD_OUT
    BundleType String Package type.
    Value range:.
  • GENERAL_BUNDLE: general.
    • .
  • STORAGE_BUNDLE: storage type
    • .
  • ENTERPRISE_BUNDLE: enterprise type
    • .
  • EXCLUSIVE_BUNDLE: exclusive
    • .
  • BEFAST_BUNDLE: beefast bundle
    • .
  • STARTER_BUNDLE: entry-level.
    • .
  • CAREFREE_BUNDLE: carefree
    • .
  • RAZOR_SPEED_BUNDLE: razor speed bundle
    • .
    BundleTypeDescription String Package type description.
    BundleDisplayLabel String Package tag.
    Valid values:
    "ACTIVITY": promotional package
    "NORMAL": regular package
    "CAREFREE": carefree package
    TrafficUnlimited Boolean Whether the traffic volume is unlimited.

    CcnAttachedInstance

    List of instances associated with the CCN instance.

    Used by actions: DescribeCcnAttachedInstances.

    Name Type Description
    CcnId String CCN instance ID.
    CidrBlock Array of String CIDR block of associated instance.
    State String Associated instance status:

    • PENDING: applying
    • ACTIVE: connected
    • EXPIRED: expired
    • REJECTED: rejected
    • DELETED: deleted
    • FAILED: failed (it will be asynchronously unassociated after 2 hours)
    • ATTACHING: associating
    • DETACHING: unassociating
    • DETACHFAILED: failed to unassociate (it will be asynchronously unassociated after 2 hours)
    AttachedTime Timestamp Association time.
    Note: this field may return null, indicating that no valid values can be obtained.
    Description String Remarks

    ContainerEnv

    Container environment variable

    Used by actions: CreateInstances.

    Name Type Required Description
    Key String Yes Environment variable key
    Value String Yes Environment variable value

    DataDiskPrice

    Data disk price

    Used by actions: InquirePriceRenewInstances.

    Name Type Description
    DiskId String

    Cloud disk ID.

    .
    OriginalDiskPrice Float

    Cloud block storage (cbs) unit price.

    unit: usd

    .
    OriginalPrice Float

    Total CBS price.

    unit: usd

    .
    Discount Float

    Discount.

    .
    DiscountPrice Float

    Discounted total price.

    unit: usd

    .
    InstanceId String

    Instance ID for data disk mounting.

    .

    DeniedAction

    Restricted operation.

    Used by actions: DescribeDisksDeniedActions, DescribeInstancesDeniedActions, DescribeSnapshotsDeniedActions.

    Name Type Description
    Action String Restricted operation name.
    Code String Restricted operation message code.
    Message String Restricted operation message.

    DestinationRegionBlueprint

    Image information of the target region.

    Used by actions: SyncBlueprint.

    Name Type Description
    Region String Target region.
    BlueprintId String Target region image ID.

    DetailPrice

    Billable items

    Used by actions: InquirePriceCreateDisks, InquirePriceCreateInstances, InquirePriceRenewDisks, InquirePriceRenewInstances.

    Name Type Description
    PriceName String

    Name of a billable item, current parameter.

  • "DiskSpace" represents the CBS space charge item.
  • "DiskBackupQuota" represents the data disk backup point quota charge item.
  • "Instance" represents the Instance charge item.
  • "SystemDiskBackupQuota" represents the system disk backup point quota charge item.
    • .
    OriginUnitPrice Float

    Unit price per billing item dimension.

    unit: usd

    .
    OriginalPrice Float

    Total price of billing item dimension.

    unit: usd

    .
    Discount Float

    Dimensional discount for billing items.

    .
    DiscountPrice Float

    Discounted total price by billing item dimension.

    unit: usd

    .

    DiscountDetail

    Package discount details (only returned for price query APIs called in the console).

    Used by actions: DescribeBundleDiscount, DescribeDiskDiscount, InquirePriceRenewInstances.

    Name Type Description
    TimeSpan Integer

    Billing duration.

    .
    TimeUnit String

    Time unit.
    value is:

    • m - month
    • d - day
    .
    TotalCost Float

    Total price.

    unit: usd

    .
    RealTotalCost Float

    Discounted total price.

    unit: usd

    .
    Discount Float

    Discount.

    .
    PolicyDetail PolicyDetail

    Specific discount details.

    .

    Disk

    Disk information

    Used by actions: DescribeDisks.

    Name Type Description
    DiskId String Disk ID
    InstanceId String Instance ID
    Zone String Availability zone
    DiskName String Disk name
    DiskUsage String Disk type
    DiskType String Disk media type
    DiskChargeType String Disk payment type
    DiskSize Integer Disk size
    RenewFlag String Renewal flag
    DiskState String Disk status. Values:
  • PENDING: Creating
  • UNATTACHED: Not attached
  • ATTACHING: Attaching
  • ATTACHED: Attached
  • DETACHING: Detaching
  • SHUTDOWN: Isolated
  • CREATED_FAILED: Failed to create
  • TERMINATING: Terminating
  • DELETING: Deleting
  • FREEZING: Freezing
    		•
    Attached Boolean Whether the disk is attached to an instance
    DeleteWithInstance Boolean Whether to release the disk along with the instance
    LatestOperation String Last operation
    LatestOperationState String Last operation status
    LatestOperationRequestId String Last request ID
    CreatedTime Timestamp ISO8601 Creation time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpiredTime Timestamp ISO8601 Expiration time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsolatedTime Timestamp ISO8601 Isolation time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiskBackupCount Integer Total disk backups
    DiskBackupQuota Integer Disk backup quota

    DiskChargePrepaid

    Parameter settings for the monthly subscribed cloud disk

    Used by actions: CreateDisks, InquirePriceCreateDisks.

    Name Type Required Description
    Period Integer Yes Purchase duration.
    RenewFlag String No Auto-Renewal flag. Valid values:

    NOTIFY_AND_AUTO_RENEW: Trigger expiration notification and renew automatically
    NOTIFY_AND_MANUAL_RENEW: Trigger expiration notification but do not renew
    u200cDISABLE_NOTIFY_AND_AUTO_RENEW: Neither trigger expiration notification nor renew

    Default: NOTIFY_AND_MANUAL_RENEW. If NOTIFY_AND_AUTO_RENEW is specified, the instance is automatically renewed on a monthly basis when the account balance is sufficient.
    TimeUnit String No Purchase duration unit. Default value: "m" (month)

    DiskConfig

    Cloud disk configuration

    Used by actions: DescribeDiskConfigs.

    Name Type Description
    Zone String Availability zone.
    DiskType String Cloud disk type. valid values are as follows:.

  • CLOUD_BASIC: basic cloud disk.
    • .
  • CLOUD_PREMIUM: specifies the high-performance cloud block storage.
    • .
  • CLOUD_SSD: ssd cloud disk
    • .
    DiskSalesState String Cloud disk sale status.
    MaxDiskSize Integer Maximum cloud disk size.
    MinDiskSize Integer Minimum cloud disk size.
    DiskStepSize Integer Cloud disk increment.

    DiskDeniedActions

    List of operation limits of disks.

    Used by actions: DescribeDisksDeniedActions.

    Name Type Description
    DiskId String Cloud disk ID.
    DeniedActions Array of DeniedAction List of operation limits.

    DiskPrice

    Cloud disk price

    Used by actions: InquirePriceCreateDisks, InquirePriceRenewDisks.

    Name Type Description
    OriginalDiskPrice Float Cloud disk unit price.
    OriginalPrice Float Total cloud disk price.
    Discount Float Discount.
    DiscountPrice Float Discounted total price.
    DetailPrices Array of DetailPrice Detailed billing items

    DiskReturnable

    Details of the returnable cloud disk

    Used by actions: DescribeDisksReturnable.

    Name Type Description
    DiskId String Cloud disk ID.
    IsReturnable Boolean Whether the cloud disk can be returned.
    ReturnFailCode Integer Error code of cloud disk return failure.
    ReturnFailMessage String Error message of cloud disk return failure.

    DockerContainerConfiguration

    Configuration used to create Docker containers

    Used by actions: CreateInstances.

    Name Type Required Description
    ContainerImage String Yes Container image address
    ContainerName String No Container name
    Envs Array of ContainerEnv No List of environment variables
    PublishPorts Array of DockerContainerPublishPort No List of mappings of container ports and host ports
    Volumes Array of DockerContainerVolume No List of container mount volumes
    Command String No The command to run

    DockerContainerPublishPort

    Port mapping of the Docker container

    Used by actions: CreateInstances.

    Name Type Required Description
    HostPort Integer Yes Host port
    ContainerPort Integer Yes Container port
    Ip String No External IP. It defaults to 0.0.0.0.
    Note: This field may return null, indicating that no valid values can be obtained.
    Protocol String No The protocol defaults to tcp. Valid values: tcp, udp and sctp.
    Note: This field may return null, indicating that no valid values can be obtained.

    DockerContainerVolume

    Docker container mount volume

    Used by actions: CreateInstances.

    Name Type Required Description
    ContainerPath String Yes Container path
    HostPath String No Host path

    Filter

    Key-Value pair filter for conditional filtering queries, such as filtering name

    • If there are multiple Filter parameters, the relationship among them is the logical AND.
    • If there are multiple Values for the same Filter, the relationship among the Values is the logical OR.

    Taking the Filter in the DescribeInstances API as an example, you can use the following filters to query the instance whose name (instance-name) is test and private IP (private-ip-address) is 10.10.10.10:

    Filters.0.Name=instance-name
&Filters.0.Values.0=test
&Filters.1.Name=private-ip-address
&Filters.1.Values.0=10.10.10.10

    Used by actions: DescribeBlueprints, DescribeBundles, DescribeDiskConfigs, DescribeDisks, DescribeImagesToShare, DescribeInstances, DescribeKeyPairs, DescribeModifyInstanceBundles, DescribeResetInstanceBlueprints, DescribeSnapshots.

    Name Type Required Description
    Name String Yes Field to be filtered.
    Values Array of String Yes Filter value of field.

    FirewallRule

    Firewall rule information.

    Used by actions: CreateFirewallRules, DeleteFirewallRules, ModifyFirewallRuleDescription, ModifyFirewallRules.

    Name Type Required Description
    Protocol String Yes Protocol. Valid values: TCP, UDP, ICMP, ALL.
    Port String No Port. Valid values: ALL, one single port, multiple ports separated by commas, or port range indicated by a minus sign
    CidrBlock String No IP range or IP (mutually exclusive). Default value: 0.0.0.0/0, which indicates all sources.
    Action String No Valid values: ACCEPT, DROP. Default value: ACCEPT.
    FirewallRuleDescription String No Firewall rule description.

    FirewallRuleInfo

    Firewall rule details.

    Used by actions: DescribeFirewallRules, DescribeFirewallRulesTemplate.

    Name Type Description
    AppType String Application type. Valid values: custom, HTTP (80), HTTPS (443), Linux login (22), Windows login (3389), MySQL (3306), SQL Server (1433), all TCP ports, all UDP ports, Ping-ICMP, ALL.
    Protocol String Protocol. Valid values: TCP, UDP, ICMP, ALL.
    Port String Port. Valid values: ALL, one single port, multiple ports separated by commas, or port range indicated by a minus sign
    CidrBlock String IP range or IP (mutually exclusive). Default value: 0.0.0.0/0, which indicates all sources.
    Action String Valid values: ACCEPT, DROP. Default value: ACCEPT.
    FirewallRuleDescription String Firewall rule description.

    GeneralResourceQuota

    General resource quota information.

    Used by actions: DescribeGeneralResourceQuotas.

    Name Type Description
    ResourceName String Resource name.
    ResourceQuotaAvailable Integer Number of available resources.
    ResourceQuotaTotal Integer Total number of resources.

    Image

    CVM image information.

    Used by actions: DescribeImagesToShare.

    Name Type Description
    ImageId String CVM Image ID, which is the unique identifier of the image.
    ImageName String Image name.
    ImageDescription String Image description.
    ImageSize Integer Image size, in GB.
    ImageSource String Image source.
  • CREATE_IMAGE: custom image.
  • EXTERNAL_IMPORT: externally imported image.
    		•
    ImageClass String Image classification.
  • SystemImage: system disk image.
  • InstanceImage: full-instance image.
    		•
    ImageState String Image status.
    CREATING: creating.
    NORMAL: normal.
    CREATEFAILED: creation failed.
    USING: in use.
    SYNCING: synchronizing.
    IMPORTING: importing.
    IMPORTFAILED: import failed.
    IsSupportCloudinit Boolean Whether the image supports Cloudinit.
    Architecture String Image architecture.
    OsName String Image operating system.
    Platform String Image source platform.
    CreatedTime Timestamp ISO8601 Image creation time.
    IsShareable Boolean Whether the image can be shared to Lighthouse.
    UnshareableReason String Reason for not being shared.

    Instance

    Instance information.

    Used by actions: DescribeInstances.

    Name Type Description
    InstanceId String Instance ID.
    BundleId String Package ID.
    BlueprintId String Image ID.
    CPU Integer Number of instance CPU cores.
    Memory Integer Instance memory capacity in GB.
    InstanceName String Instance name.
    InstanceChargeType String Instance billing mode. Valid values:
    PREPAID: prepaid (i.e., monthly subscription).
    SystemDisk SystemDisk Instance system disk information.
    PrivateAddresses Array of String Private IP of instance primary ENI.
    Note: this field may return null, indicating that no valid values can be obtained.
    PublicAddresses Array of String Public IP of instance primary ENI.
    Note: this field may return null, indicating that no valid values can be obtained.
    InternetAccessible InternetAccessible Instance bandwidth information.
    RenewFlag String Auto-Renewal flag. Valid values:
    NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically
    NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically.
    LoginSettings LoginSettings Instance login settings.
    InstanceState String Instance status. Valid values:
  • PENDING: Creating
  • LAUNCH_FAILED: Failed to create
  • RUNNING: Running
  • STOPPED: Shut down
  • STARTING: Starting up
  • STOPPING: Shutting down
  • REBOOTING: Restarting
  • SHUTDOWN: Shutdown and to be terminated
  • TERMINATING: Terminating
  • DELETING: Deleting
  • FREEZING: Frozen
  • ENTER_RESCUE_MODE: Entering the rescue mode
  • RESCUE_MODE: Rescue mode
  • EXIT_RESCUE_MODE: Exiting from the rescue mode
    		•
    Uuid String Globally unique ID of instance.
    LatestOperation String Last instance operation, such as StopInstances and ResetInstance. Note: this field may return null, indicating that no valid values can be obtained.
    LatestOperationState String Last instance operation status. Valid values:
    SUCCESS: operation succeeded
    OPERATING: the operation is being executed
    FAILED: operation failed
    Note: this field may return null, indicating that no valid values can be obtained.
    LatestOperationRequestId String Unique request ID for the last operation of the instance.
    Note: this field may return null, indicating that no valid values can be obtained.
    IsolatedTime Timestamp ISO8601 Isolation time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: this field may return null, indicating that no valid values can be obtained.
    CreatedTime Timestamp ISO8601 Creation time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: this field may return null, indicating that no valid values can be obtained.
    ExpiredTime Timestamp ISO8601 Expiration time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: this field may return null, indicating that no valid values can be obtained.
    PlatformType String OS type, such as LINUX_UNIX and WINDOWS.
    Platform String OS type.
    OsName String OS name.
    Zone String AZ.
    Tags Array of Tag The list of tags associated with the instance
    InstanceRestrictState String Obtain instance status
  • NORMAL: The instance is normal
  • NETWORK_RESTRICT: The instance is blocked from the network.
    		•

    InstanceChargePrepaid

    Instance billing mode

    Used by actions: CreateInstances, InquirePriceCreateInstances, InquirePriceRenewInstances, RenewInstances.

    Name Type Required Description
    Period Integer Yes Duration of instance purchase. measurement unit: month.
    -Valid values when creating an instance: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
    -When renewing an instance, valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    RenewFlag String No AUTO-Renewal flag. valid values:
  • NOTIFY_AND_AUTO_RENEW: NOTIFY AND AUTO-RENEW on expiration

  • NOTIFY_AND_MANUAL_RENEW: NOTIFY expiration without AUTO-RENEW. users need to manually RENEW.

  • DISABLE_NOTIFY_AND_MANUAL_RENEW: no AUTO-renewal AND no notification


    • default value: NOTIFY_AND_MANUAL_RENEW. if this parameter is set to NOTIFY_AND_AUTO_RENEW, the instance will automatically RENEW on a monthly basis after expiration when the account balance is sufficient.

    InstanceDeniedActions

    List of instance operation limits.

    Used by actions: DescribeInstancesDeniedActions.

    Name Type Description
    InstanceId String Instance ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    DeniedActions Array of DeniedAction List of operation limits.

    InstancePrice

    About Lighthouse Instance price.

    Used by actions: InquirePriceCreateInstances, InquirePriceRenewInstances.

    Name Type Description
    OriginalBundlePrice Float

    Unit price of the package.

    unit: usd

    .
    OriginalPrice Float

    Original price.

    unit: usd

    .
    Discount Float

    Discount.

    .
    DiscountPrice Float

    Discounted price.

    unit: usd

    .
    Currency String

    Price currency unit. valid values: USD.

    .
    DetailPrices Array of DetailPrice

    Billing item detail.

    .

    InstancePriceDetail

    Instance price details

    Used by actions: InquirePriceRenewInstances.

    Name Type Description
    InstanceId String Instance ID.
    InstancePrice InstancePrice Price inquiry information.
    DiscountDetail Array of DiscountDetail Discount gradient details. each gradient includes duration, discount percentage, total price, discount price, and discount details (user discount, official website discount, final discount).

    InstanceReturnable

    Whether the instance can be returned.

    Used by actions: DescribeInstancesReturnable.

    Name Type Description
    InstanceId String Instance ID.
    IsReturnable Boolean Whether the instance can be returned.
    ReturnFailCode Integer Error code of instance return failure.
    ReturnFailMessage String Error message of instance return failure.

    InstanceTrafficPackage

    Instance traffic package details

    Used by actions: DescribeInstancesTrafficPackages.

    Name Type Description
    InstanceId String Instance ID.
    TrafficPackageSet Array of TrafficPackage List of traffic package details.

    InternetAccessible

    This describes the internet accessibility of the instance created by a launch configuration and declares the internet usage billing method of the instance and the maximum bandwidth

    Used by actions: DescribeInstances.

    Name Type Description
    InternetChargeType String Network billing mode. Valid values:
  • Bill by traffic package: TRAFFIC_POSTPAID_BY_HOUR
  • Bill by bandwidth: BANDWIDTH_POSTPAID_BY_HOUR
    		•
    InternetMaxBandwidthOut Integer Public network outbound bandwidth cap in Mbps.
    PublicIpAssigned Boolean Whether to assign a public IP.

    KeyPair

    Key pair information.

    Used by actions: CreateKeyPair, DescribeKeyPairs.

    Name Type Description
    KeyId String Key pair ID, which is the unique identifier of a key pair.
    KeyName String Key pair name.
    PublicKey String Public key (in plain text) of key pair.
    AssociatedInstanceIds Array of String List of IDs of instances associated with the key pair.
    Note: this field may return null, indicating that no valid values can be obtained.
    CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used
    Note: this field may return null, indicating that no valid values can be obtained.
    PrivateKey String Private key of key pair.
    Note: this field may return null, indicating that no valid values can be obtained.

    LoginConfiguration

    Login password information

    Used by actions: CreateInstances.

    Name Type Required Description
    AutoGeneratePassword String No
  • YES: Random password. In this case, Password cannot be specified.
  • No: Custom. Password must be specified.
    • Password String No Instance login password.
    For Windows instances, the password must contain 12 to 30 characters of the following types. It cannot start with “/” and cannot include the username.
  • Lowercase letters: [a–z]
  • Uppercase letters: [A–Z]
  • Digits: 0-9
  • Symbols: ()`~!@#$%^&*-+=_
    		•
    KeyIds Array of String No Key ID list. You can specify up to 5 keys simultaneously. After associating keys, you can access the instance using the corresponding private key. Keys and passwords cannot be specified simultaneously. Additionally, the WINDOWS operating system does not support key specification. The key ID list can be obtained via the DescribeKeyPairs API.

    LoginSettings

    Describes login settings of an instance.

    Used by actions: DescribeInstances.

    Name Type Description
    KeyIds Array of String Key ID list. After a key is associated, you can use it to access the instance. Note: this field may return [], indicating that no valid values can be obtained.

    ModifyBundle

    Changeable packages for the instance.

    Used by actions: DescribeModifyInstanceBundles.

    Name Type Description
    ModifyPrice Price Price difference that you need to pay for the new instance package after change.
    ModifyBundleState String Package change status. Valid values:
  • SOLD_OUT: packages are sold out
  • AVAILABLE: packages can be changed
  • UNAVAILABLE: packages cannot be changed currently
    		•
    Bundle Bundle Package information.
    NotSupportModifyMessage String The reason of package changing failure. It’s empty if the package change status is AVAILABLE.
    Note: This field may return null, indicating that no valid values can be obtained.

    PolicyDetail

    Discount details.

    Used by actions: DescribeBundleDiscount, DescribeDiskDiscount, InquirePriceRenewInstances.

    Name Type Description
    UserDiscount Float User discount.
    CommonDiscount Float Public discount.
    FinalDiscount Float Final discount.
    ActivityDiscount Float Activity discount. The value null indicates no discount.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiscountType String Discount type.
    Valid values: user (user discount), common (discount displayed on the official website), activity (activity discount), null (no discount).
    Note: This field may return null, indicating that no valid values can be obtained.

    Price

    Price information

    Used by actions: DescribeBundles, DescribeModifyInstanceBundles, InquirePriceCreateInstances, InquirePriceRenewInstances.

    Name Type Description
    InstancePrice InstancePrice Instance price.

    RegionInfo

    Region information.

    Used by actions: DescribeRegions.

    Name Type Description
    Region String Region name, such as ap-guangzhou.
    RegionName String Region description, such as South China (Guangzhou).
    RegionState String Region availability status. Its value can only be AVAILABLE.
    IsChinaMainland Boolean Whether the region is in the Chinese mainland

    RenewDiskChargePrepaid

    Parameter settings for renewing the monthly subscribed cloud disk

    Used by actions: InquirePriceRenewDisks, RenewDisks.

    Name Type Required Description
    Period Integer No Renewal period
    RenewFlag String No Whether to renew the disk automatically. Values:

    NOTIFY_AND_AUTO_RENEW: Trigger expiration notification and renew automatically; NOTIFY_AND_MANUAL_RENEW: Trigger expiration notification but do not renew; DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not trigger the notification and do not renew.

    Default: NOTIFY_AND_MANUAL_RENEW. If NOTIFY_AND_AUTO_RENEW is specified, the instance is automatically renewed on a monthly basis when the account balance is sufficient.
    TimeUnit String No Unit of the period. Values: m (month).
    CurInstanceDeadline String No Expiration time of the current instance, such as "2018-01-01 00:00:00". Specify this parameter to align the expiration time of the instance and attached cloud disks. CurInstanceDeadline and Period cannot be both specified.

    ResetInstanceBlueprint

    Image reset information

    Used by actions: DescribeResetInstanceBlueprints.

    Name Type Description
    BlueprintInfo Blueprint Image details
    IsResettable Boolean Whether the image can be reset as the target image
    NonResettableMessage String Non-Resettable flag. If the image is resettable, it will be ""

    Scene

    Scene information

    Used by actions: DescribeScenes.

    Name Type Description
    SceneId String Scene ID
    DisplayName String Display name of the scene
    Description String Scene description

    SceneInfo

    Scene information

    Used by actions: DescribeAllScenes.

    Name Type Description
    SceneId String Scene ID
    DisplayName String Display name of the scene
    Description String Scene description

    Snapshot

    Snapshot information.

    Used by actions: DescribeSnapshots.

    Name Type Description
    SnapshotId String Snapshot ID.
    DiskUsage String Type of the disk for which the snapshot is created. Valid values:
  • SYSTEM_DISK: system disk
    		•
    DiskId String ID of the disk for which the snapshot is created.
    DiskSize Integer Size of the disk in GB for which the snapshot is created.
    SnapshotName String Snapshot name, which is a custom snapshot alias.
    SnapshotState String Snapshot status. Valid values:
  • NORMAL: normal
  • CREATING: creating
  • ROLLBACKING: rolling back
    		•
    Percent Integer Snapshot creation or rollback progress in percentage. After success, the value of this field will become 100.
    LatestOperation String Last snapshot operation. It is recorded only during snapshot creation and rollback.
    Example values: CreateInstanceSnapshot, RollbackInstanceSnapshot.
    Note: this field may return null, indicating that no valid values can be obtained.
    LatestOperationState String Last snapshot operation status. It is recorded only during snapshot creation and rollback.
    Valid values:
  • SUCCESS: operation succeeded
  • OPERATING: the operation is being executed
  • FAILED: operation failed

    • Note: this field may return null, indicating that no valid values can be obtained.
    LatestOperationRequestId String Unique request ID for the last snapshot operation. It is recorded only during snapshot creation and rollback.
    Note: this field may return null, indicating that no valid values can be obtained.
    CreatedTime Timestamp ISO8601 Snapshot creation time.
    Note: This field may return null, indicating that no valid values can be obtained.

    SnapshotDeniedActions

    List of snapshot operation limits.

    Used by actions: DescribeSnapshotsDeniedActions.

    Name Type Description
    SnapshotId String Snapshot ID.
    DeniedActions Array of DeniedAction List of operation limits.

    Software

    Image software information.

    Used by actions: DescribeBlueprintInstances.

    Name Type Description
    Name String Software name.
    Version String Software version.
    ImageUrl String Software picture URL.
    InstallDir String Software installation directory.
    DetailSet Array of SoftwareDetail List of software details.

    SoftwareDetail

    Image software details.

    Used by actions: DescribeBlueprintInstances.

    Name Type Description
    Key String Unique detail key
    Title String Detail title.
    Value String Detail value.

    SystemDisk

    Information on the block device where the operating system is installed, namely the system disk.

    Used by actions: DescribeInstances.

    Name Type Description
    DiskType String System disk type.
    Valid values:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_SSD: SSD cloud disk
  • CLOUD_PREMIUM: Premium Cloud Storage
    		•
    DiskSize Integer System disk size in GB.
    DiskId String System disk ID.
    Note: this field may return null, indicating that no valid values can be obtained.

    Tag

    Information on tags

    Used by actions: DescribeInstances.

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

    TotalPrice

    Total price information

    Used by actions: InquirePriceRenewInstances.

    Name Type Description
    OriginalPrice Float

    Original total price.

    unit: usd

    .
    DiscountPrice Float

    Total price after discount.

    unit: usd

    .

    TrafficPackage

    Traffic package details.

    Used by actions: DescribeInstancesTrafficPackages.

    Name Type Description
    TrafficPackageId String Traffic package ID.
    TrafficUsed Integer Used traffic in bytes during traffic package validity period.
    TrafficPackageTotal Integer Total traffic in bytes during traffic package validity period.
    TrafficPackageRemaining Integer Remaining traffic in bytes during traffic package validity period.
    TrafficOverflow Integer Traffic exceeding package amount in bytes during traffic package validity period.
    StartTime Timestamp ISO8601 Start time of traffic package validity period according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTime Timestamp ISO8601 End time of traffic package validity period according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: this field may return null, indicating that no valid values can be obtained.
    Deadline Timestamp ISO8601 Traffic package expiration time according to ISO 8601 standard. UTC time is used.
    Format: YYYY-MM-DDThh:mm:ssZ.
    Note: this field may return null, indicating that no valid values can be obtained.
    Status String Traffic package status:
  • NETWORK_NORMAL: normal
  • OVERDUE_NETWORK_DISABLED: the network is disconnected due to overdue payments
    		•

    ZoneInfo

    AZ details

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ
    ZoneName String Chinese name of AZ
    InstanceDisplayLabel String AZ tags on instance purchase page
    Anterior: DescribeZonesPróximo: Error Codes

    Ajuda e Suporte

    Esta página foi útil?

    comentários