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
文档APIsTencent Cloud TI PlatformData Types

Data Types

聚焦模式
字号
最后更新时间： 2025-11-13 20:53:06

AuthToken

AuthToken data of an online service.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Base AuthTokenBase No AuthToken basic information.
Limits Array of AuthTokenLimit No AuthToken throttling array.

AuthTokenBase

AuthToken basic information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Value String No Token value.
Name String No Token alias.
Description String No Token description.
CreateTime String No Token creation time.
Status String No Token status.

AuthTokenLimit

AuthToken throttling information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Strategy String No Frequency limit policy. Valid values: PerMinute (frequency limit per minute) and PerDay (daily frequency limit).
Max Integer No Upper limit.

CFSConfig

CFS storage configurations.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Id String Yes CFS instance ID.
Path String Yes Storage path.
MountType String No Mounting type of CFS. Valid values: STORAGE and SOURCE, which respectively indicate the storage expansion mode and the data source mode. The default value is STORAGE.Note: This field may return null, indicating that no valid values can be obtained.
Protocol String No Protocol. Valid values: NFS and TURBO.Note: This field may return null, indicating that no valid values can be obtained.

Container

Container information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Name String Yes Name.Note: This field may return null, indicating that no valid values can be obtained.
ContainerId String Yes id
Note: This field may return null, indicating that no valid values can be obtained.
Image String Yes Image address.Note: This field may return null, indicating that no valid values can be obtained.
Status ContainerStatus Yes Container status.Note: This field may return null, indicating that no valid values can be obtained.

ContainerStatus

Container status.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
RestartCount Integer Yes Number of restarts.Note: This field may return null, indicating that no valid values can be obtained.
State String Yes Status.Note: This field may return null, indicating that no valid values can be obtained.
Ready Boolean Yes Whether it is ready.Note: This field may return null, indicating that no valid values can be obtained.
Reason String Yes Status reason.Note: This field may return null, indicating that no valid values can be obtained.
Message String Yes Container error message.Note: This field may return null, indicating that no valid values can be obtained.

CosPathInfo

COS path information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Bucket String Yes Bucket.Note: This field may return null, indicating that no valid values can be obtained.
Region String Yes Region.Note: This field may return null, indicating that no valid values can be obtained.
Paths Array of String Yes Path list. Only one path is supported.Note: This field may return null, indicating that no valid values can be obtained.

CronScaleJob

Scheduled scaling task.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Schedule String Yes Cron expression, which identifies the task execution time, and is accurate to minutes.
Name String No Scheduled task name.Note: This field may return null, indicating that no valid values can be obtained.
TargetReplicas Integer No Number of target instances.Note: This field may return null, indicating that no valid values can be obtained.
MinReplicas Integer No Minimum target.Note: This field may return null, indicating that no valid values can be obtained.
MaxReplicas Integer No Maximum target.Note: This field may return null, indicating that no valid values can be obtained.
ExcludeDates Array of String No Exception periods, defined by Cron expressions, during which tasks are not executed. Up to 3 Cron expressions are supported.Note: This field may return null, indicating that no valid values can be obtained.

CrossTenantENIInfo

Information about Pod calls involving ENIs across tenants.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
PrimaryIP String No Pod IP address.Note: This field may return null, indicating that no valid values can be obtained.
Port String No Pod port.Note: This field may return null, indicating that no valid values can be obtained.

EnvVar

Environment variables.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Name String No Environment variable key.Note: This field may return null, indicating that no valid values can be obtained.
Value String No Environment variable value.Note: This field may return null, indicating that no valid values can be obtained.

ExecAction

Probe check action for execution commands.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Command Array of String No Execution command list.

Filter

Filter.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Name String No Filter field name.
Values Array of String No Filter field values.
Negative Boolean No Whether to enable reverse query.
Fuzzy Boolean No Whether to enable fuzzy matching.

GooseFSx

GooseFSx configurations.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Id String No GooseFSx instance ID.
Path String No Path to mount the GooseFSx instance.

GpuDetail

GPU details.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Name String No GPU card type. Enumeration values: V100, A100, T4.Note: This field may return null, indicating that no valid values can be obtained.
Value Integer No GPU card quantity, in 1/100 cards. For example, 100 represents 1 card.Note: This field may return null, indicating that no valid values can be obtained.

HTTPGetAction

HTTP GET action.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Path String No HTTP path.
Port Integer No Called port.

HealthProbe

Health probe.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
LivenessProbe Probe No Liveness probe.
ReadinessProbe Probe No Readiness probe.
StartupProbe Probe No Startup probe.

HorizontalPodAutoscaler

HPA description.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
MinReplicas Integer Yes Minimum number of instances.Note: This field may return null, indicating that no valid values can be obtained.
MaxReplicas Integer Yes Maximum number of instances.Note: This field may return null, indicating that no valid values can be obtained.
HpaMetrics Array of Option Yes Supported."gpu-util": GPU utilization; value range: 10-100. "cpu-util": CPU utilization; value range: 10-100. "memory-util": memory utilization; value range: 10-100. "service-qps": the QPS value of single instances; value range: 1-5000."concurrency-util": the number of concurrent requests of single instances. Value range: 1-100000.Note: This field may return null, indicating that no valid values can be obtained.
ScaleUpStabilizationWindowSeconds Integer No Scale-out cooldown period, in seconds.
ScaleDownStabilizationWindowSeconds Integer No Scale-in cooldown period, in seconds.

ImageInfo

Image description information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
ImageType String Yes Image type. Valid values: TCR ( which indicates a Tencent Container Registry (TCR) image), CCR (which indicates a TCR Personal Edition image), PreSet (which indicates a platform preset image), and CUSTOM (which indicates a third-party custom image).
ImageUrl String Yes Image address.
RegistryRegion String No Region corresponding to the TCR image.Note: This field may return null, indicating that no valid values can be obtained.
RegistryId String No Instance ID corresponding to the TCR image.Note: This field may return null, indicating that no valid values can be obtained.
AllowSaveAllContent Boolean No Whether to allow exporting all content.Note: This field may return null, indicating that no valid values can be obtained.
ImageName String No Image name.Note: This field may return null, indicating that no valid values can be obtained.
SupportDataPipeline Boolean No Whether to support data generation.Note: This field may return null, indicating that no valid values can be obtained.

InferCodeInfo

Inference code information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
CosPathInfo CosPathInfo Yes Details of Cloud Object Storage (COS) where the inference code is located.Note: This field may return null, indicating that no valid values can be obtained.

LogConfig

Log configurations.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
LogsetId String Yes Logs should be shipped to a Cloud Log Service (CLS) log set.Note: This field may return null, indicating that no valid values can be obtained.
TopicId String Yes Logs should be shipped to a CLS topic.Note: This field may return null, indicating that no valid values can be obtained.

ModelInfo

Model description information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
ModelVersionId String Yes The model version ID is returned by the DescribeTrainingModelVersion API when querying the model.Enter the task ID of the Automated Machine Learning (AutoML) model.
ModelId String No Model ID.
ModelName String No Model name.
ModelVersion String No Model version.
ModelSource String No Model source.
CosPathInfo CosPathInfo No COS path information.
GooseFSx GooseFSx No GooseFSx configurations, and is valid when ModelSource is GooseFSx.
AlgorithmFramework String No Algorithm framework corresponding to the model (reserved field).Note: This field may return null, indicating that no valid values can be obtained.
ModelType String No Default: NORMAL; accelerated model: ACCELERATE; automatic learning model: AUTO_ML.Note: This field may return null, indicating that no valid values can be obtained.
ModelFormat String No Model format.Note: This field may return null, indicating that no valid values can be obtained.
IsPrivateModel Boolean No Whether it is a private LLM.Note: This field may return null, indicating that no valid values can be obtained.
ModelCategory String No Model category. Valid values: MultiModal (multi-modal) and LLM (text LLM).
PublicDataSource PublicDataSourceFS No Data source configurations.

NumOrPercent

Percentage or quantity.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Type String No Valid values: Num and Percent, which indicate quantity and percentage respectively. The default value is Num.
Value Integer No Numeric value.

Option

Key-value pair.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Name String Yes Metric name.
Value Integer Yes Metric value.

Pod

Pod information display.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Name String No Pod name.Note: This field may return null, indicating that no valid values can be obtained.
Uid String No Unique ID of the Pod.Note: This field may return null, indicating that no valid values can be obtained.
ChargeType String No Service payment mode.Note: This field may return null, indicating that no valid values can be obtained.
Phase String No Pod status.Note: This field may return null, indicating that no valid values can be obtained.
IP String No Pod IP address.Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String No Pod creation time.Note: This field may return null, indicating that no valid values can be obtained.
ContainerInfos Array of Container No Container list.Note: This field may return null, indicating that no valid values can be obtained.
CrossTenantENIInfo CrossTenantENIInfo No Container calling information.Note: This field may return null, indicating that no valid values can be obtained.
Status String No Instance status information.
StartScheduleTime String No Instance scheduling start time.
Message String No Supplemental instance status information.
NodeIP String No Node IP address of the current instance.
NodeId String No Node ID of the current instance.
ResourceGroupId String No Resource group ID to which the instance belonged.
ResourceGroupName String No Resource group name.
ResourceInfo ResourceInfo No Resource usage information of the instance.

Probe

Probe structure information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
ProbeAction ProbeAction No Probe action.
InitialDelaySeconds Integer No Delay in waiting for a service startup.
PeriodSeconds Integer No Polling check interval.
TimeoutSeconds Integer No Check timeout duration.
FailureThreshold Integer No Number of acknowledged failed detections.
SuccessThreshold Integer No Number of acknowledged successful detections. The default values for readiness, liveness, and startup statuses are 3, 1, and 1.

ProbeAction

Probe action.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
HTTPGet HTTPGetAction No HTTP GET action.
Exec ExecAction No Executes check command action.
TCPSocket TCPSocketAction No TCP Socket check action.
ActionType String No Probe type. The default value is HTTPGet. Valid values: HTTPGet, Exec, and TCPSocket.

PublicDataSourceFS

Public cloud data source structure.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
DataSourceId String No Data source ID.
SubPath String No Relative subpath to the data source.

ResourceGroupInfo

Summarized information structure for the serviced resource group while an online service is provided.

Used by actions: DescribeModelServiceGroups.

Name Type Description
ResourceGroupId String Resource group ID.
ResourceGroupName String Resource group name.

ResourceInfo

Resource information description.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Cpu Integer Yes Processor resource, in 1/1000 cores.Note: This field may return null, indicating that no valid values can be obtained.
Memory Integer Yes Memory resource, in MB.Note: This field may return null, indicating that no valid values can be obtained.
Gpu Integer No Number of GPU card resources, in 0.01 units of GpuType.Gpu=100 indicates the use of "1" GPU card. However, this "1" card could refer to a virtualized 1/4 card or a full physical card, depending on the instance type.Example 1: If the instance type includes 1 virtual GPU card, and each virtual GPU card corresponds to 1/4 of a physical T4 card, then GpuType=T4, Gpu=100, and RealGpu=25.Example 2: If the instance type includes 4 full GPU cards, and each card corresponds to 1 physical T4 card, then GpuType=T4, Gpu=400, and RealGpu=400.Note: This field may return null, indicating that no valid values can be obtained.
GpuType String No GPU card model. Valid values: T4 and V100. It only displays the current GPU card model. If multiple types of cards are used simultaneously, see the value of RealGpuDetailSet.Note: This field may return null, indicating that no valid values can be obtained.
RealGpu Integer No It is not required for creation or update operations. This field is used for display only.The actual GPU card resources for postpaid instances using fractional GPU cards. This value represents the total number of actual physical GPU cards consumed.RealGpu=100 indicates the consumption of 1 GPU card. Depending on the actual instance type, this may represent: 4 instances each using a 1/4 card, 2 instances each using a 1/2 card, or 1 instance using a full card.
RealGpuDetailSet Array of GpuDetail No It is not required for creation or update operations. This field is used for display only. It involves detailed GPU usage information.

RollingUpdate

Rolling update policy.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
MaxUnavailable NumOrPercent No Maximum unavailability for rolling updates.
MaxSurge NumOrPercent No Maximum number of new instances during rolling updates.

ScheduledAction

Scheduled transactions and actions.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
ScheduleStop Boolean No Whether to stop the service on schedule. Valid values: true and false. If the value is true, ScheduleStopTime is required. If the value is false, ScheduleStopTime does not take effect.
ScheduleStopTime String No Time to execute the scheduled stop. Format: "2022-01-26T19:46:22+08:00".

SchedulingPolicy

Service scheduling policy configurations.

Used by actions: DescribeModelServiceGroups.

Name Type Description
CrossResourceGroupScheduling Boolean Whether to enable cross-resource-group scheduling.

Service

Online service description.

Used by actions: DescribeModelServiceGroups.

Name Type Description
ServiceGroupId String Service group ID.
ServiceId String Service ID.
ServiceGroupName String Service group name.
ServiceDescription String Service description.Note: This field may return null, indicating that no valid values can be obtained.
ServiceInfo ServiceInfo Service details.Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String Cluster ID.Note: This field may return null, indicating that no valid values can be obtained.
Region String Region.Note: This field may return null, indicating that no valid values can be obtained.
Namespace String Namespace.Note: This field may return null, indicating that no valid values can be obtained.
ChargeType String Billing type.Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupId String Resource group ID for yearly/monthly subscription services. The value is null for pay-as-you-go services.Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupName String Resource group name corresponding to the yearly/monthly subscription service.Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Tag of the service.Note: This field may return null, indicating that no valid values can be obtained.
IngressName String Name of the ingress where the service is located.Note: This field may return null, indicating that no valid values can be obtained.
CreatedBy String Creator.Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time.Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time.Note: This field may return null, indicating that no valid values can be obtained.
Uin String Root account.Note: This field may return null, indicating that no valid values can be obtained.
SubUin String Sub-account.Note: This field may return null, indicating that no valid values can be obtained.
AppId Integer app_id
Note: This field may return null, indicating that no valid values can be obtained.
BusinessStatus String Operational status of the service.Note: This field may return null, indicating that no valid values can be obtained.
CreateFailedReason String Cause for service creation failure. The default value of this field is CREATE_SUCCEED upon successful creation.Note: This field may return null, indicating that no valid values can be obtained.
Status String Service status.CREATING: creating.CREATE_FAILED: creation failed.Normal: running.Stopped: stopped.Stopping: stopping.Abnormal: error.Pending: starting.Waiting: getting ready.Note: This field may return null, indicating that no valid values can be obtained.
BillingInfo String Billing information.Note: This field may return null, indicating that no valid values can be obtained.
Weight Integer Model weight.Note: This field may return null, indicating that no valid values can be obtained.
CreateSource String Creation source of the service.AUTO_ML: comes from one-click release of automatic learning.DEFAULT: other sources.Note: This field may return null, indicating that no valid values can be obtained.
Version String Version number.Note: This field may return null, indicating that no valid values can be obtained.
LatestVersion String The latest version number of services under a service group.Note: This field may return null, indicating that no valid values can be obtained.
ResourceGroupSWType String Resource group category. Valid values: NORMAL (hosting) and SW (half-hosting).Note: This field may return null, indicating that no valid values can be obtained.
ArchiveStatus String Archiving status of the service. Valid values: Waiting (pending archiving) and Archived (archived).Note: This field may return null, indicating that no valid values can be obtained.
DeployType String Deployment type of the service. Valid values: STANDARD (standard deployment) and DIST (multi-machine distributed deployment). The default value is STANDARD.Note: This field may return null, indicating that no valid values can be obtained.
InstancePerReplicas String Number of instances per replica. This parameter is valid only when the deployment type is DIST. Default value: 1.Note: This field may return null, indicating that no valid values can be obtained.
MonitorSource String Source for monitoring queries.Enumeration value. May differ from CreateSource in certain scenarios. This field is designed to be compatible.
SubUinName String Sub-account name of the service creator.
SchedulingPolicy SchedulingPolicy Scheduling policy of the service.
ExternalResourceGroups Array of ResourceGroupInfo External resource group information, indicating which resources are borrowed from resource groups.

ServiceEIP

Service shared Elastic Network Interface (ENI) settings.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
EnableEIP Boolean No Whether to enable access from the TI-ONE private network to external resources.Note: This field may return null, indicating that no valid values can be obtained.
VpcId String No User VPC ID.Note: This field may return null, indicating that no valid values can be obtained.
SubnetId String No User subnet ID.Note: This field may return null, indicating that no valid values can be obtained.

ServiceGroup

Information of a service group for an online service.

Used by actions: DescribeModelServiceGroups.

Name Type Description
ServiceGroupId String Service group ID.
ServiceGroupName String Service group name.
CreatedBy String Creator.
CreateTime String Creation time.
UpdateTime String Update time.
Uin String Root account.
ServiceCount Integer Total number of services in the service group.Note: This field may return null, indicating that no valid values can be obtained.
RunningServiceCount Integer Number of running services in the service group.Note: This field may return null, indicating that no valid values can be obtained.
Services Array of Service Service description.Note: This field may return null, indicating that no valid values can be obtained.
Status String Service group status, which aligns with service status.CREATING: creating.CREATE_FAILED: creation failed.Normal: running.Stopped: stopped.Stopping: stopping.Abnormal: error.Pending: starting.Waiting: getting ready.Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Service group tags.Note: This field may return null, indicating that no valid values can be obtained.
LatestVersion String The latest version in the service group.Note: This field may return null, indicating that no valid values can be obtained.
BusinessStatus String Operational status of the service.CREATING: creating.CREATE_FAILED: creation failed.ARREARS_STOP: service suspended due to overdue payments.BILLING: billing.WHITELIST_USING: allowlist feature is in trial.WHITELIST_STOP: insufficient allowlist quota.Note: This field may return null, indicating that no valid values can be obtained.
BillingInfo String Billing information of the service.Note: This field may return null, indicating that no valid values can be obtained.
CreateSource String Creation source of the service.Note: This field may return null, indicating that no valid values can be obtained.
WeightUpdateStatus String Weight update status of the service group.UPDATING: updating.UPDATED: updated successfully.UPDATE FAILED: failed to update.Note: This field may return null, indicating that no valid values can be obtained.
ReplicasCount Integer Number of running Pods in the service group.Note: This field may return null, indicating that no valid values can be obtained.
AvailableReplicasCount Integer Expected number of Pods under the service group.Note: This field may return null, indicating that no valid values can be obtained.
SubUin String Service group's subuin.
AppId Integer Service group's app_id.
AuthorizationEnable Boolean Whether to enable authentication.
AuthTokens Array of AuthToken List of throttling authentication tokens.
MonitorSource String Field for monitoring creation source.
SubUinName String Nickname of the sub-user.

ServiceInfo

Information of the inference service in the cluster.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Replicas Integer Yes Expected number of running Pods. The instance is 0 when the stop status is reached.Corresponding relationships under different billing and scaling modes are as follows.PREPAID and POSTPAID_BY_HOUR:Corresponding number of instances in the manual scaling mode.Corresponding number of instances based on the default time-based policy in the auto-scaling mode.HYBRID_PAID:
Corresponding number of instances for postpaid instances in the manual scaling mode.Corresponding number of instances under the default time-based policy for postpaid instances in the auto-scaling mode.Note: This field may return null, indicating that no valid values can be obtained.
ImageInfo ImageInfo Yes Image information.Note: This field may return null, indicating that no valid values can be obtained.
Env Array of EnvVar Yes Environment variables.Note: This field may return null, indicating that no valid values can be obtained.
Resources ResourceInfo Yes Resource information.Note: This field may return null, indicating that no valid values can be obtained.
InstanceType String Yes Type specifications corresponding to the postpaid instance.Note: This field may return null, indicating that no valid values can be obtained.
ModelInfo ModelInfo Yes Model information.Note: This field may return null, indicating that no valid values can be obtained.
LogEnable Boolean Yes Whether to enable logs.Note: This field may return null, indicating that no valid values can be obtained.
LogConfig LogConfig Yes Log configurations.Note: This field may return null, indicating that no valid values can be obtained.
AuthorizationEnable Boolean Yes Whether to enable authentication.Note: This field may return null, indicating that no valid values can be obtained.
HorizontalPodAutoscaler HorizontalPodAutoscaler Yes HPA configurations.Note: This field may return null, indicating that no valid values can be obtained.
Status WorkloadStatus Yes Description of the service status.Note: This field may return null, indicating that no valid values can be obtained.
Weight Integer Yes Weight.Note: This field may return null, indicating that no valid values can be obtained.
ResourceTotal ResourceInfo Yes Total resources.Note: This field may return null, indicating that no valid values can be obtained.
OldReplicas Integer Yes Number of historical instances.Note: This field may return null, indicating that no valid values can be obtained.
HybridBillingPrepaidReplicas Integer Yes This parameter is valid when the billing mode is HYBRID_PAID, and is used to identify the number of prepaid instances in the hybrid billing mode. The default value is 1 if this parameter is left unspecified.Note: This field may return null, indicating that no valid values can be obtained.
OldHybridBillingPrepaidReplicas Integer Yes Number of instances during the historical HYBRID_PAID period. The user restores services.Note: This field may return null, indicating that no valid values can be obtained.
ModelHotUpdateEnable Boolean Yes Whether to enable hot update for the model. By default, hot update is disabled.Note: This field may return null, indicating that no valid values can be obtained.
InstanceAlias String No Service specification alias.
ScaleMode String No Instance quantity adjusting mode. Defaults to manual.Supported valid values: AUTO (automatic), MANUAL (manual).Note: This field may return null, indicating that no valid values can be obtained.
CronScaleJobs Array of CronScaleJob No Scheduled scaling task.Note: This field may return null, indicating that no valid values can be obtained.
ScaleStrategy String No Scheduled scaling policy.Note: This field may return null, indicating that no valid values can be obtained.
ScheduledAction ScheduledAction No Configurations of the scheduled stop.Note: This field may return null, indicating that no valid values can be obtained.
PodInfos Array of Pod No Pod list information.Note: This field may return null, indicating that no valid values can be obtained.
ServiceLimit ServiceLimit No Configurations related to speed limit and throttling of services.Note: This field may return null, indicating that no valid values can be obtained.
ModelTurboEnable Boolean No Whether to enable model acceleration, which is only valid for models in the StableDiffusion (dynamic acceleration) format.Note: This field may return null, indicating that no valid values can be obtained.
VolumeMount VolumeMount No Mounting.Note: This field may return null, indicating that no valid values can be obtained.
InferCodeInfo InferCodeInfo No Inference code information.Note: This field may return null, indicating that no valid values can be obtained.
Command String No Service startup command.Note: This field may return null, indicating that no valid values can be obtained.
ServiceEIP ServiceEIP No Settings of enabling the TI-ONE private network to access external resources.Note: This field may return null, indicating that no valid values can be obtained.
ServicePort Integer No Service port, with the default value of 8501.Note: This field may return null, indicating that no valid values can be obtained.
TerminationGracePeriodSeconds Integer No Graceful exit time limit of the service, in seconds. Default value: 30. Minimum value: 1.
PreStopCommand Array of String No Command executed before the service instance stops. The instance ends after the command execution is completed or after the execution time exceeds the graceful exit time limit.
GrpcEnable Boolean No Whether to enable the gRPC port.
HealthProbe HealthProbe No Health probe.
RollingUpdate RollingUpdate No Rolling update configurations.
InstancePerReplicas Integer No Number of instances per replica. This parameter is valid only when the deployment type is DIST or ROLE. Default value: 1.
VolumeMounts Array of VolumeMount No Batch data disk mounting configurations.

ServiceLimit

Configurations related to throttling and speed limit of services.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
EnableInstanceRpsLimit Boolean No Whether to enable throttling and speed limit at the instance level. Valid values: true and false. If the value is true, InstanceRpsLimit is required. If the value is false, InstanceRpsLimit does not take effect.
InstanceRpsLimit Integer No Speed limit for the requests per second (RPS) of each service instance. 0 indicates no throttling.
EnableInstanceReqLimit Boolean No Whether to enable the maximum concurrency quantity limit for a single instance. Valid values: true and false. If the value is true, InstanceReqLimit is required. If the value is false, InstanceReqLimit does not take effect.
InstanceReqLimit Integer No Maximum concurrency for each service instance.

StatefulSetCondition

Instance status.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Message String Yes Information.Note: This field may return null, indicating that no valid values can be obtained.
Reason String Yes Reason.Note: This field may return null, indicating that no valid values can be obtained.
Status String Yes Status of the condition, True, False or Unknown.Note: This field may return null, indicating that no valid values can be obtained.
Type String Yes Type.Note: This field may return null, indicating that no valid values can be obtained.
LastTransitionTime String Yes Last update time.Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTime String No Last update time.Note: This field may return null, indicating that no valid values can be obtained.

TCPSocketAction

Check action of a TCP Socket health probe.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Port Integer No Called port.

Tag

Tencent Cloud tag description.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
TagKey String Yes Tag key.Note: This field may return null, indicating that no valid values can be obtained.
TagValue String Yes Tag value.Note: This field may return null, indicating that no valid values can be obtained.

TagFilter

Tag filtering parameters.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
TagKey String No Tag key.
TagValues Array of String No Multiple tag values.

VolumeMount

External mounting information.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
CFSConfig CFSConfig Yes Cloud File Storage (CFS) configuration information.
VolumeSourceType String No Mounting source type. Valid values: CFS and COS. The default value is CFS.
MountPath String No Mounting path in the custom container.Note: This field may return null, indicating that no valid values can be obtained.

WorkloadStatus

Workload status.

Used by actions: DescribeModelServiceGroups.

Name Type Required Description
Replicas Integer Yes Number of current instances.
UpdatedReplicas Integer Yes Number of updated instances.
ReadyReplicas Integer Yes Number of ready instances.
AvailableReplicas Integer Yes Number of available instances.
UnavailableReplicas Integer Yes Number of unavailable instances.
Status String Yes Normal: running.Abnormal: service abnormalities, such as container startup failure.Waiting: service waiting, such as container image pulling.Stopped: stopped.Pending: starting.Stopping: stopping.
Conditions Array of StatefulSetCondition No Status information of workload history.
Reason String No Display the reason when the status is abnormal.Note: This field may return null, indicating that no valid values can be obtained.
上一篇: DescribeModelServiceGroups下一篇: Error Codes

帮助和支持

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

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

文档反馈