tencent cloud

APIs

Cloud Virtual Machine
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Tencent Cloud Lighthouse
History
Introduction
API Category
Making API Requests
Image APIs
Firewall APIs
Key APIs
Instance APIs
CCN APIs
Snapshot APIs
Other APIs
Cloud Disk APIs
Scene APIs
Package APIs
Quota APIs
Region APIs
Data Types
Error Codes
Auto Scaling
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
Batch Compute
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
Tencent Cloud Automation Tools
History
Introduction
API Category
Making API Requests
Remote Command APIs
Scheduled Execution APIs
Managed Instance APIs
Scenario APIs
Statistics APIs
Data Types
Error Codes
Edge Computing Machine
History
API Category
Making API Requests
Region APIs
Module APIs
Instance APIs
Image APIs
VPC APIs
Subnet APIs
Route Table APIs
CLB APIs
ENI APIs
EIP APIs
HAVIP APIs
Other API
Key APIs
Security Group APIs
Data Types
Error Codes
Tencent Kubernetes Engine
History
Introduction
API Category
Making API Requests
Elastic Cluster APIs
Resource Reserved Coupon APIs
Cluster APIs
Third-party Node APIs
Relevant APIs for Addon
Network APIs
Node APIs
Node Pool APIs
TKE Edge Cluster APIs
Cloud Native Monitoring APIs
Scaling group APIs
Super Node APIs
Other APIs
Data Types
Error Codes
TKE API 2022-05-01
Tencent Container Registry
History
Introduction
API Category
Making API Requests
Instance Management APIs
Namespace APIs
Access Control APIs
Instance Synchronization APIs
Tag Retention APIs
Trigger APIs
Helm Chart APIs
Image Repository APIs
Custom Account APIs
Data Types
Error Codes
Tencent Cloud Elastic Microservice
History
Introduction
API Category
Making API Requests
Environment APIs
ModifyIngress
Resource APIs
Application APIs
Service APIs
Application Deployment APIs
Access Policy APIs
Configuration file APIs
Log collecting APIs
Scaling Rule APIs
Application Version APIs
Other APIs
Workload APIs
Data Types
Error Codes
Serverless Cloud Function
History
Introduction
API Category
Making API Requests
Other APIs
Namespace APIs
Layer Management APIs
Async Event Management APIs
Trigger APIs
Function APIs
Function and Layer Status Description
Data Types
Error Codes
Event Bridge
History
Introduction
API Category
Making API Requests
Delivery Target APIs
Event Bus APIs
Event Rule APIs
Event Connector APIs
Data Transformer APIs
Event Storage APIs
Data Types
Error Codes
Cloud Object Storage
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
Cloud File Storage
History
Introduction
API Category
Snapshot APIs
File system APIs
Lifecycle APIs
Other APIs
Data Flow APIs
Making API Requests
Permission Group APIs
Service APIs
Scaling APIs
Data Migration APIs
Data Types
Error Codes
Cloud Block Storage
History
Introduction
API Category
Making API Requests
Snapshot APIs
Cloud Disk APIs
Data Types
Error Codes
Cloud HDFS
History
Introduction
API Category
Making API Requests
Other APIs
Permission group APIs
Permission rule APIs
Mount point APIs
Lifecycle rule APIs
File system APIs
Restoration task APIs
Data Types
Error Codes
Cloud Log Service
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
Kafka Task APIs
Kafka Data Subscription APIs
COS Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
TDSQL-C for MySQL
History
Introduction
API Category
Making API Requests
Instance APIs
Multi-Availability Zone APIs
Other APIs
Audit APIs
Database Proxy APIs
Backup and Recovery APIs
Parameter Management APIs
Billing APIs
serverless APIs
Resource Package APIs
Account APIs
Performance Analysis APIs
Data Types
Error Codes
TencentDB for MySQL
History
Introduction
API Category
Instance APIs
Making API Requests
Data Import APIs
Database Proxy APIs
Database Audit APIs
Security APIs
Task APIs
Backup APIs
Account APIs
Rollback APIs
Parameter APIs
Database APIs
Monitoring APIs
Log-related API
Data Types
Error Codes
TencentDB for MariaDB
History
Introduction
API Category
Making API Requests
Security Group APIs
Other APIs
Account APIs
Parameter Management APIs
Monitoring Management APIs
Instance Management APIs
Backup and Restoration APIs
Data Types
Error Codes
TencentDB for PostgreSQL
History
Introduction
API Category
Making API Requests
Instance APIs
Read-only Replica APIs
Backup and Recovery APIs
Parameter Management APIs
Security Group APIs
Performance Optimization APIs
Account APIs
Specification APIs
Network APIs
Data Types
Error Codes
TencentDB for SQL Server
History
Introduction
API Category
Making API Requests
Sales and fee related APIs
Instance Management related APIs
Operation and maintenance management related APIs
Network management related APIs
Account management related APIs
Database management related APIs
Security group management related APIs
Data security encryption related APIs
Parameter configuration related APIs
Extended Event related APIs
Log management related APIs
Read only instance management related APIs
Publish and subscribe related APIs
Backup related APIs
Data migration (cold standby migration) related APIs
Rollback related APIs
Data migration (DTS old version) related APIs
SQL Server Integration Services (SSIS) related APIs
Data Types
Error Codes
TDSQL for MySQL
History
Introduction
API Category
Security Group APIs
Other APIs
Making API Requests
TDSQL APIs
Data Types
Error Codes
Tencent Cloud Distributed Cache (Redis OSS-Compatible)
History
Introduction
API Category
Making API Requests
Instance APIs
Parameter Management APIs
Other APIs
Backup and Restoration APIs
Region APIs
Monitoring and Management APIs
Log APIs
Data Types
Error Codes
TencentDB for MongoDB
History
Introduction
API Category
Making API Requests
Instance APIs
Backup APIs
Account APIs
Other APIs
Task APIs
Introduction
Data Types
Error Codes
TencentDB for TcaplusDB
History
Introduction
API Category
Making API Requests
Table Group APIs
Other APIs
Table APIs
Cluster APIs
Data Types
Error Codes
Data Transfer Service
History
Introduction
API Category
Making API Requests
(NewDTS) Data Migration APIs
Data Sync APIs
Data Consistency Check APIs
(NewDTS) Data Subscription APIs
Data Types
Error Codes
DTS API 2018-03-30
TencentDB for DBbrain
History
Introduction
Introduction
API Category
Making API Requests
Session Killing APIs
Exception Detection APIs
Other APIs
Redis related APIs
Health Report Email Sending APIs
Space Analysis APIs
Security Audit APIs
Slow Log Analysis APIs
Database Audit APIs
Data Types
Error Codes
DBbrain APIs 2019-10-16
Virtual Private Cloud
History
Introduction
API Category
Making API Requests
VPC APIs
Route Table APIs
Elastic Public IP APIs
Elastic IPv6 APIs
Highly Available Virtual IP APIs
ENI APIs
Bandwidth Package APIs
NAT Gateway APIs
Direct Connect Gateway APIs
Cloud Connect Network APIs
Network ACL APIs
Network Parameter Template APIs
Network Detection-Related APIs
Flow Log APIs
Gateway Traffic Monitor APIs
Private Link APIs
Traffic Mirroring APIs
Other APIs
Subnet APIs
VPN Gateway APIs
Security Group APIs
Snapshot Policy APIs
Error Codes
Data Types
Cloud Load Balancer
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
Direct Connect
History
Introduction
API Category
Making API Requests
Direct Connect APIs
Data Types
Error Codes
Content Delivery Network
History
Introduction
API Category
Content Management APIs
Real-time Log APIs
Service Query APIs
Data Query APIs
Making API Requests
Log Query APIs
Domain Name Management APIs
Configuration Management APIs
Obsoleted APIs
Other APIs
Data Types
Error Codes
Global Application Acceleration Platform
History
Introduction
API Category
Rule APIs
Connection Group APIs
Making API Requests
Origin Server APIs
Listener APIs
Connection APIs
Certificate APIs
Other APIs
Data Types
Error Codes
Tencent Cloud Firewall
History
Introduction
API Category
Making API Requests
Intrusion Defense APIs
Access Control APIs
Other APIs
Enterprise Security Group APIs
Firewall Status APIs
Data Types
Error Codes
Tencent Cloud EdgeOne
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
Cloud Workload Protection Platform
History
Introduction
API Category
Asset Management APIs
Virus Scanning APIs
Abnormal Log-in APIs
Password Cracking APIs
Malicious Request APIs
High-Risk Command APIs
Local Privilege Escalation APIs
Reverse Shell APIs
Vulnerability Management APIs
New Baseline Management APIs
Baseline Management APIs
Advanced Defense APIs
Security Operation APIs
Expert Service APIs
Other APIs
Overview Statistics APIs
Settings Center APIs
Making API Requests
Intrusion Detection APIs
Data Types
Error Codes
Key Management Service
History
Introduction
API Category
Key APIs
Making API Requests
Asymmetric Key APIs
Data Types
Error Codes
Secrets Manager
History
Introduction
API Category
Making API Requests
Data Security APIs
Other APIs
Data Types
Error Codes
Captcha
History
Introduction
API Category
Making API Requests
Server APIs
Error Codes
Customer Identity and Access Management
History
Introduction
API Category
Making API Requests
User Management APIs
Data Sync APIs
Audit Management APIs
Data Types
Error Codes
Security Token Service
History
Introduction
API Category
Making API Requests
STS APIs
Data Types
Error Codes
SSL Certificates
History
Introduction
API Category
Making API Requests
Certificate APIs
Certificate Renewal (Certificate ID Unchanged) APIs
CSR APIs
Data Types
Error Codes
Private DNS
History
Introduction
API Category
Making API Requests
Private DNS APIs
Data Types
Error Codes
DNSPod
History
Introduction
API Category
Making API Requests
Line APIs
Package and Value-Added Service APIs
Batch Operation APIs
Group APIs
Record APIs
DNS Query Volume APIs
Alias APIs
Domain APIs
Data Types
Error Codes
Elastic MapReduce
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
Elasticsearch Service
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
Data Lake Compute
History
Introduction
API Category
Making API Requests
Data Table APIs
Task APIs
Metadata APIs
Service Configuration APIs
Permission Management APIs
Database APIs
Data Source Connection APIs
Data Optimization APIs
Data Engine APIs
Resource Group for the Standard Engine APIs
Data Types
Error Codes
Face Recognition
History
Introduction
API Category
Making API Requests
Face Detection and Analysis APIs
Facial Feature Localization APIs
Face Comparison APIs
Group Management APIs
Face Search APIs
Face Verification APIs
Image-based Liveness Detection (High Precision) APIs
Data Types
Error Codes
eKYC
History
Introduction
API Category
Making API Requests
Selfie Verification (Pure API) APIs
Selfie Verification (App SDK) APIs
Identity Verification (App SDK) APIs
Identity Verification(Mobile HTML5) APIs
AI Face Shield (Pure API) APIs
Other APIs
Data Types
Error Codes
Text To Speech
History
Introduction
API Category
Making API Requests
General Text-to-Speech APIs
Data Types
Error Codes
Tencent Machine Translation
History
Introduction
API Category
Making API Requests
APIs
Error Codes
Optical Character Recognition
History
Introduction
API Category
Making API Requests
Document Intelligent APIs
Card and Document OCR APIs
General Text OCR APIs
Vehicle Scene OCR APIs
Data Types
Error Codes
IoT Hub
History
Introduction
API Category
Making API Requests
Device Shadow APIs
Device APIs
CA Certificate APIs
Product APIs
Data Types
Error Codes
TDMQ for CKafka
History
Introduction
API Category
Making API Requests
Other APIs
ACL APIs
Instance APIs
Routing APIs
DataHub APIs
Topic APIs
Data Types
Error Codes
Cloud Message Queue
History
API Category
Making API Requests
Topic APIs
Queue APIs
Introduction
Data Types
Error Codes
Chat
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Short Message Service
History
Introduction
API Category
Making API Requests
SMS Mobile Number APIs
SMS Conversion Rate APIs
Status Pull APIs
SMS Statistics APIs
SMS Signature APIs
SMS Delivery APIs
SMS Template APIs
Data Types
Error Codes
SMS Callback APIs
Tencent Push Notification Service
Overview
API Overview
Call Method
Push APIs
Tag APIs
Account APIs
Statistics APIs
User Attribute APIs
Server-Side Error Codes
Server SDKs
API (Java)
Simple Email Service
History
Introduction
API Category
Making API Requests
Domain Verification APIs
Mail APIs
Template APIs
Statistics APIs
Sender Address APIs
Blocklist APIs
Sending Status Query APIs
Batch Task APIs
Custom Blocklist APIs
Data Types
Error Codes
Tencent Real-Time Communication
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
StreamLive
History
Introduction
API Category
Making API Requests
Input Management APIs
Input Security Group Management APIs
Channel Management APIs
Plan APIs
Watermark Management APIs
Statistics APIs
Data Types
Error Codes
StreamPackage
History
Introduction
API Category
Making API Requests
Channel Management APIs
Advertising Insertion Configuration Management APIs
Channel linear assembly management APIs
VOD remux task APIs
Usage Query APIs
HarvestJob Management APIs
Data Types
Error Codes
StreamLink
History
API Category
Making API Requests
Flow APIs
Data Types
Error Codes
Cloud Streaming Services
History
Introduction
API Category
Making API Requests
Live Pad APIs
Live Stream Mix APIs
Time Shifting APIs
Monitoring Data Query APIs
Billing Data Query APIs
Live Transcoding APIs
Delayed Playback Management APIs
Domain Name Management APIs
Watermark Management APIs
Certificate Management APIs
Stream Pulling APIs
Recording Management APIs
Live Callback APIs
Screencapturing and Porn Detection APIs
Authentication Management APIs
Live Stream Management APIs
Data Types
Error Codes
Video on Demand
History
Introduction
API Category
Other APIs
Media Processing APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Parameter Template APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
Media Processing Service
History
Introduction
API Category
Making API Requests
Processing Task Initiation APIs
Task Management APIs
Transcoding and Enhancement Template APIs
Watermark Template APIs
Screenshot Template APIs
Media AI Template APIs
Media AI—Hotword Lexicon APIs
Media AI—Sample Management APIs
Media Quality Inspection Template APIs
Live Streaming Recording Template APIs
Orchestration Management APIs
Data Statistics APIs
StreamLink—Security Group Management APIs
Other APIs
Image Processing Template APIs
AI Generation APIs
Other APIs
Data Types
Error Codes
Cloud Application Rendering
History
Introduction
API Category
Making API Requests
User APIs
Application Management APIs
Project Management APIs
Concurrency Management APIs
Stream Push Service APIs
Data Types
Error Codes
Game Multimedia Engine
History
Introduction
API Category
Usage APIs
Recording APIs
Making API Requests
Voice Chat APIs
Application APIs
Data Types
Error Codes
Tag
History
Introduction
API Category
Making API Requests
Write APIs
Read APIs
Project APIs
Data Types
Error Codes
Cloud Access Management
History
Introduction
API Category
Making API Requests
User APIs
Policy APIs
Role APIs
Identity Provider APIs
Data Types
Error Codes
CloudAudit
History
Introduction
API Category
Calling Method
CloudAudit APIs
Data Types
Error Codes
Tencent Cloud Organization
History
Introduction
API Category
Making API Requests
Organization Settings APIs
Department and Member Management APIs
Unified Member Login APIs
Member Access Management APIs
Organization Service Management APIs
Organization Management Policy APIs
Resource Sharing APIs
Identity Center Management APIs
Identity Center User Management APIs
Identity Center User Group Management APIs
Identity Center Management SCIM Synchronization APIs
Identity Center Single Sign-On Management APIs
Identity Center Permission Configuration Management APIs
Identity Center Multi-Account Authorization Management APIs
Identity Center Sub-User Synchronization Management APIs
Data Types
Error Codes
TCO API 2018-12-25
Tencent Cloud Observability Platform
History
Introduction
API Category
Making API Requests
Monitoring Data Query APIs
Alarm APIs
Legacy Alert APIs
Notification Template APIs
TMP APIs
Grafana Service APIs
Event Center APIs
TencentCloud Managed Service for Prometheus APIs
Monitoring APIs
Data Types
Error Codes
Real User Monitoring
History
Introduction
API Category
Making API Requests
Console APIs
Business System and Project Information APIs
Custom Speed Test APIs
Custom Event APIs
API Monitoring APIs
Exception Analysis APIs
Page View APIs
Static Resource Monitoring APIs
Log APIs
Page Performance APIs
Data Types
Error Codes
International Partners
History
Introduction
API Category
Making API Requests
Customer Management APIs
Credit Management APIs
Agent APIs
Bill Management APIs
Voucher Management APIs
Commission Management APIs
Data Types
Error Codes
Billing Center
API Category
Funds Management APIs
Order Management APIs
Resource Management APIs
Bill Management APIs
Cost Allocation Management APIs
Cost Management APIs
Making API Requests
Organization Account APIs
Data Types
Error Codes
TDSQL Boundless
History
Introduction
API Category
Making API Requests
Instance APIs
Security Group APIs
Task APIs
Backup APIs
Rollback APIs
Parameter APIs
Database APIs
Data Types
Error Codes
TDMQ for MQTT
History
Introduction
API Category
Making API Requests
Cluster APIs
Topic APIs
Authorization Policy APIs
User APIs
Client APIs
Message APIs
Message Enhancement Rule APIs
Data Types
Error Codes
Tencent HY
History
Introduction
API Category
Making API Requests
Hunyuan Text APIs
Hunyuan 3D APIs
Data Types
Error Codes
Smart Media Hosting
History
Introduction
API Category
Making API Requests
PaaS Service APIs
Official Cloud Disk APIs
Data Types
Error Codes
Quota Center
History
Introduction
API Category
Making API Requests
Alarm APIs
Data Types
Error Codes
Message Center
History
Introduction
API Category
Making API Requests
Message Subscription APIs
Data Types
Error Codes
Business Intelligence
History
Introduction
API Category
Making API Requests
Project Management APIs
Role APIs
Database Table APIs
Report Embedding APIs
Page Management APIs
Data Types
Error Codes
LLM Knowledge Engine Basic API
History
Introduction
API Category
Making API Requests
Atomic Capability APIs
Data Types
Error Codes
Tencent Cloud Agent Development Platform
History
API Category
Making API Requests
Atomic Capability APIs
Operation Optimization APIs
Document Library APIs
Q&A Database APIs
Knowledge Tag APIs
Application Management APIs
Enterprise Management APIs
Billing APIs
Release Management APIs
Dialogue Endpoint APIs
Data Statistics APIs
Data Types
Error Codes
Tencent Cloud Blockchain as a Service
History
Introduction
API Category
Making API Requests
Hyperledger Fabric 2.3 APIs
Data Types
Error Codes
Performance Testing Service
History
Introduction
API Category
Making API Requests
PTS-related APIs
Data Types
Error Codes
Real-time Teleoperation
History
Introduction
API Category
Making API Requests
Project APIs
Device APIs
Session APIs
Authorization APIs
Other APIs
Data Types
Error Codes
Gateway Load Balancer
History
Introduction
API Category
Making API Requests
Target Group APIs
GWLB APIs
Other APIs
Data Types
Error Codes
Identity Aware Platform
History
Introduction
API Category
Making API Requests
IAP APIs
Error Codes
Cloud Dedicated Cluster
History
Introduction
API Category
Making API Requests
Cloud Dedicated Cluster (CDC) APIs
Data Types
Error Codes
Image Creation Large Model
History
Introduction
API Category
Making API Requests
Image Style Transfer APIs
Data Types
Error Codes
Face Fusion
API Category
Making API Requests
Image Face Fusion (Basic) APIs
Video Face Fusion (Single Face) APIs
Data Types
Error Codes
Tencent Smart Advisor-Chaotic Fault Generator
History
Introduction
API Category
Making API Requests
Task APIs
Template Library APIs
Data Types
Error Codes
Tencent HealthCare Omics Platform
History
Introduction
API Category
Making API Requests
Environment Management APIs
Tencent Healthcare Omics Platform APIs
Data Types
Error Codes
Tencent Cloud TCHouse-D
History
Introduction
API Category
Making API Requests
Cluster Operation APIs
Database and Table APIs
Cluster Information Viewing APIs
Hot-Cold Data Layering APIs
Database and Operation Audit APIs
User and Permission APIs
Resource Group Management APIs
Data Types
Error Codes
Tencent Cloud WeData
History
Introduction
API Category
Making API Requests
Project Management APIs
Smart Ops Related Interfaces
Resource Group APIs
Data Development APIs
Data Asset - Data Dictionary APIs
Data Development APIs
Ops Center APIs
Data Exploration APIs
Data Operations Related Interfaces
Asset APIs
Metadata Related Interfaces
Task Operations APIs
Data Security APIs
Instance Operation and Maintenance Related Interfaces
Data Map and Data Dictionary APIs
Data Quality Related Interfaces
DataInLong APIs
Platform Management APIs
Data Source Management APIs
Data Quality APIs
Platform Management APIs
Asset Data APIs
Data Source Management APIs
Data Types
Error Codes
WeData API 2025-08-06
Anti-DDoS
History
Introduction
API Category
Making API Requests
Anti-DDoS Advanced Instance APIs
Resource List APIs
Protection Configuration APIs
Other APIs
Alarm Notification APIs
Connection Configuration APIs
Intelligent Scheduling APIs
Black hole unblocking APIs
Statistical Report APIs
Data Types
Error Codes
Cloud Contact Center
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Tencent Cloud Super App as a Service
History
Introduction
API Category
Making API Requests
Operation Management APIs
Platform Management APIs
Sensitive API-Related APIs
Role Management APIs
Team Management APIs
Other Console APIs
Mini Program or Mini Game APIs
Management-Sensitive APIs
Global Domain Management APIs
Superapp APIs
User Management APIs
Data Types
Tencent Cloud Smart Advisor
History
Introduction
API Category
Making API Requests
Other APIs
Task APIs
Cloud Architecture Console APIs
Data Types
Error Codes
TDMQ for RabbitMQ
History
Introduction
API Category
Making API Requests
Relevant APIs for RabbitMQ Serverless PAAS Capacity
RabbitMQ Serverless Instance Management APIs
Data Types
Error Codes
Control Center
History
Introduction
API Category
Making API Requests
Account Factory APIs
Data Types
Error Codes
TDMQ for CMQ
API Documentation
API 2.0 to 3.0 Switch Guide
Tencent Cloud TCHouse-P
History
Introduction
API Category
Making API Requests
Information Query APIs
Instance APIs
Query APIs
Cluster Management APIs
Cluster Operation APIs
Data Types
Error Codes
TDMQ for RocketMQ
History
API Category
Making API Requests
Topic APIs
Consumer Group APIs
Message APIs
Role Authentication APIs
Hitless Migration APIs
Cloud Migration APIs
Cluster APIs
Data Types
Error Codes
Cloud Dedicated Zone
History
Introduction
API Category
Making API Requests
Availability Zone APIs
Data Types
Error Codes
Tencent Cloud Health Dashboard
History
Introduction
API Category
Making API Requests
Event APIs
Data Types
Error Codes
Application Performance Management
History
Introduction
API Category
Making API Requests
Application APIs
Business System APIs
General Query APIs
Unavailable APIs
Performance Analysis APIs
Data Types
Error Codes
Config
History
Introduction
API Category
Making API Requests
Rule APIs
Resource APIs
Data Types
Error Codes
Automatic Speech Recognition
History
Introduction
API Category
Making API Requests
Recording Recognition APIs
Real-Time Speech Recognition APIs
Data Types
Error Codes
Tencent Cloud TI Platform
History
Introduction
API Category
Making API Requests
Online Service APIs
Data Types
Error Codes
Web Application Firewall
History
Introduction
API Category
Making API Requests
Asset Management APIs
Billing APIs
Protection Settings APIs
Other APIs
IP Management APIs
Integration APIs
Log Service APIs
Security Overview APIs
Rule Engine APIs
Data Types
Error Codes
Cloud Security Center
History
Introduction
API Category
Making API Requests
Multi-account management related APIs
Scan Task APIs
Risk Center APIs
Asset Center APIs
Cloud Boundary Analysis APIs
Cloud API Anomaly Detection APIs
Report Download APIs
Solid Protection APIs
Cloud Security Center Overview APIs
Data Types
Error Codes
Risk Control Engine
History
Introduction
API Category
Making API Requests
TencentCloud API APIs
Data Types
Error Codes
TencentDB for CTSDB
History
Introduction
API Category
Making API Requests
Instance APIs
Database APIs
Data Types
Error Codes
Tencent Interactive Whiteboard
History
Introduction
API Category
Making API Requests
Whiteboard Push APIs
Other APIs
Document Transcoding APIs
Real-Time Recording APIs
Statistics Query APIs
Whiteboard Snapshot APIs
Recording Video Generation APIs
Data Types
Error Codes
Tencent Container Security Service
History
Introduction
API Category
Making API Requests
Network Security APIs
Cluster Security APIs
Security Compliance APIs
Runtime security - High-risk syscalls
Runtime Security - Reverse Shell APIs
Runtime Security APIs
Alert Settings APIs
Advanced prevention - K8s API abnormal requests
Asset Management APIs
Security Operations - Log Analysis APIs
Runtime Security - Trojan Call APIs
Runtime Security - Container Escape APIs
Image Security APIs
Billing APIs
Data Types
Error Codes
Domains
History
Introduction
API Category
Making API Requests
Domain Management APIs
Domain Query APIs
Bulk Operation APIs
Registrant Profile APIs
Other APIs
Data Types
Error Codes
Low-code Interactive Classroom
History
Introduction
API Category
Making API Requests
User Login APIs
Room Management APIs
Group Management APIs
Application Configuration APIs
Recording Management APIs
Courseware Management APIs
User Management APIs
Developer APIs
Data Types
Error Codes

Data Types

聚焦模式
字号
最后更新时间: 2026-03-26 22:26:51

CreateInput

Configuration information of the created input.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput.

Name Type Required Description
InputName String Yes Input name, which can contain 1 to 32 letters, digits, and underscores.
Protocol String Yes Input protocol. Valid values: SRT, RTP, RTMP, RTMP_PULL, RTSP_PULL, HLS_PULL.
Description String No Input description. Length: [0, 255].
AllowIpList Array of String No Allowlist of input IPs in CIDR format.
SRTSettings CreateInputSRTSettings No SRT configuration information of input.
RTPSettings CreateInputRTPSettings No RTP configuration information of input.
FailOver String No Input failover. Valid values: OPEN, CLOSE (default)
RTMPPullSettings CreateInputRTMPPullSettings No Input RTMP_PULL configuration information.
RTSPPullSettings CreateInputRTSPPullSettings No Input RTSP_PULL configuration information.
HLSPullSettings CreateInputHLSPullSettings No Input HLS_PULL configuration information.
ResilientStream ResilientStreamConf No Delayed broadcast smooth streaming configuration information.
SecurityGroupIds Array of String No The bound security group IDs.
Zones Array of String No Availability zone, optional. If disaster recovery is enabled, you must enter two different availability zones. Otherwise, you can only enter one availability zone at most.

CreateInputHLSPullSettings

Created input HLS pull stream configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
SourceAddresses Array of HLSPullSourceAddress Yes The origin server address for the HLS origin server. There can be only one.

CreateInputRTMPPullSettings

Created input RTMP pull stream configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
SourceAddresses Array of RTMPPullSourceAddress Yes The origin server address for the RTMP origin server. There can be only one.

CreateInputRTPSettings

RTP configuration information of the created input.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
FEC String No Default value: none. Valid values: ['none'].
IdleTimeout Integer No Idle timeout period in ms. Default value: 5000. Value range: [1000, 10000].

CreateInputRTSPPullSettings

Created input RTSP pull stream configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
SourceAddresses Array of RTSPPullSourceAddress Yes The origin server address for the RTSP origin server. There can be only one.

CreateInputSRTSettings

SRT configuration information of the created input.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Mode String No The SRT mode. Valid values: LISTENER (default), CALLER.
StreamId String No Stream ID, which can contain 0 to 512 letters, digits, and special characters (.#!:&,=_-).
Latency Integer No Latency in ms. Default value: 0. Value range: [0, 3000].
RecvLatency Integer No Receive latency in ms. Default value: 120. Value range: [0, 3000].
PeerLatency Integer No Peer latency in ms. Default value: 0. Value range: [0, 3000].
PeerIdleTimeout Integer No Peer timeout period in ms. Default value: 5000. Value range: [1000, 10000].
Passphrase String No Decryption key, which is empty by default, indicating not to encrypt. Only ASCII codes can be filled. Length: [10, 79].
PbKeyLen Integer No Key length. Default value: 0. Valid values: 0, 16, 24, 32.
SourceAddresses Array of SRTSourceAddressReq No The SRT peer address, which is required if Mode is CALLER. Only one address is allowed.

CreateOutputInfo

The information of the output to create.

Used by actions: CreateStreamLinkOutputInfo.

Name Type Required Description
OutputName String Yes The output name.
Description String Yes Description of the output.
Protocol String Yes The output protocol. Valid values: SRT, RTP, RTMP, RTMP_PULL.
OutputRegion String Yes The output region.
SRTSettings CreateOutputSrtSettings No The SRT configuration.
RTMPSettings CreateOutputRTMPSettings No The RTMP configuration.
RTPSettings CreateOutputInfoRTPSettings No The RTP configuration.
AllowIpList Array of String No IP whitelist, in CIDR format, such as 0.0.0.0/0. This is valid when Protocol is RTMP_PULL, and empty means no restriction on client IP.
MaxConcurrent Integer No The maximum number of concurrent stream pulls is 4, and the default value is 4.
SecurityGroupIds Array of String No The bound security group IDs.
Zones Array of String No Availability zone: output supports at most one availability zone as input.

CreateOutputInfoRTPSettings

The RTP configuration of the output to create.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Destinations Array of CreateOutputRTPSettingsDestinations Yes The relay destination addresses. One or two addresses are allowed.
FEC String Yes This parameter must be set to none.
IdleTimeout Integer Yes The timeout period (ms).

CreateOutputRTMPSettings

The RTMP configuration of the output to create.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Destinations Array of CreateOutputRtmpSettingsDestinations Yes The relay destination addresses. One or two addresses are allowed.
ChunkSize Integer No The RTMP chunk size. Value range: [4096, 40960].

CreateOutputRTPSettingsDestinations

The RTP destination address of the output to create.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Ip String Yes The relay destination IP.
Port Integer Yes The relay destination port.

CreateOutputRtmpSettingsDestinations

The RTMP destination address of the output to create.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Url String Yes The relay URL. Format: rtmp://domain/live.
StreamKey String Yes The StreamKey for relay. Format: stream?key=value.

CreateOutputSrtSettings

The SRT configuration of the output to create.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Destinations Array of CreateOutputSrtSettingsDestinations Yes The relay destination address, which is required if Mode is CALLER. Only one address is allowed.
StreamId String No The stream ID for relay, which can contain 0 to 512 letters, digits, and special characters (.#!:&,=_-).
Latency Integer No The total latency (ms) of SRT relay. Value range: [0, 3000]. Default: 0.
RecvLatency Integer No The receive latency (ms) of SRT relay. Value range: [0, 3000]. Default: 120.
PeerLatency Integer No The peer-to-peer latency (ms) of SRT relay. Value range: [0, 3000]. Default: 0.
PeerIdleTimeout Integer No The timeout period (ms) for the SRT relay peer. Value range: [1000, 10000]. Default: 5000.
Passphrase String No The encryption key for SRT relay, which is empty by default, indicating not to encrypt. Only ASCII codes are allowed. Length: [10, 79].
PbKeyLen Integer No The key length for SRT relay. Valid values: 0 (default), 16, 24, 32.
Mode String No The SRT mode. Valid values: LISTENER, CALLER (default).

CreateOutputSrtSettingsDestinations

The SRT destination address of the output to create.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Ip String Yes The output IP.
Port Integer Yes The output port.

DescribeFlow

Configuration information of the queried flow.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkFlow, DescribeStreamLinkFlows.

Name Type Description
FlowId String Flow ID.
FlowName String Flow name.
State String Flow status. Valid values: IDLE, RUNNING
MaxBandwidth Integer Maximum bandwidth value.
InputGroup Array of DescribeInput Input group.
OutputGroup Array of DescribeOutput Output group.
Note: this field may return null, indicating that no valid values can be obtained.
EventId String EventId of the StreamLink event associated with this Flow.

DescribeHLSPullSourceAddress

Query the input HLS configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Url String The Url of the HLS origin server.

DescribeInput

Configuration information of the queried input.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput.

Name Type Description
InputId String Input ID.
InputName String Input name.
Description String Input description.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Input protocol.
InputAddressList Array of InputAddress Input address list.
AllowIpList Array of String Input IP allowlist.
SRTSettings DescribeInputSRTSettings SRT configuration information of input.
Note: this field may return null, indicating that no valid values can be obtained.
RTPSettings DescribeInputRTPSettings RTP configuration information of input.
Note: this field may return null, indicating that no valid values can be obtained.
InputRegion String Input region.
RTMPSettings DescribeInputRTMPSettings RTMP configuration information of an input
FailOver String Input failover
Note: this field may return null, indicating that no valid value was found.
RTMPPullSettings DescribeInputRTMPPullSettings Input RTMP_PULL configuration.
RTSPPullSettings DescribeInputRTSPPullSettings Input RTSP_PULL configuration.
HLSPullSettings DescribeInputHLSPullSettings Input HLS_PULL configuration.
ResilientStream ResilientStreamConf Delayed broadcast smooth stream delivery configuration.
SecurityGroupIds Array of String The bound security group ID.

DescribeInputHLSPullSettings

Query the input HLS configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Description
SourceAddresses Array of DescribeHLSPullSourceAddress The address information of the HLS origin server.

DescribeInputRTMPPullSettings

Query the input RTMP configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Description
SourceAddresses Array of DescribeRTMPPullSourceAddress The address information of the RTMP origin server.

DescribeInputRTMPSettings

RTMP configuration information of the queried input

Used by actions: ModifyStreamLinkInput.

Name Type Description
AppName String Path for RTMP stream pushing
Note: this field may return null, indicating that no valid value was found.
StreamKey String StreamKey for RTMP stream pushing
Format of an RTMP stream pushing URL: rtmp://IP address:1935/AppName/StreamKey

DescribeInputRTPSettings

RTP configuration information of the queried input.

Used by actions: ModifyStreamLinkInput.

Name Type Description
FEC String Whether it is FEC.
IdleTimeout Integer Idle timeout period.

DescribeInputRTSPPullSettings

Query the input RTSP configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Description
SourceAddresses Array of DescribeRTSPPullSourceAddress The address information of the RTSP origin server.

DescribeInputSRTSettings

SRT configuration information of the queried input.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Mode String The SRT mode.
Note: This field may return null, indicating that no valid value can be obtained.
StreamId String Stream ID.
Latency Integer Latency.
RecvLatency Integer Receive latency.
PeerLatency Integer Peer latency.
PeerIdleTimeout Integer Peer idle timeout period.
Passphrase String Decryption key.
PbKeyLen Integer Key length.
SourceAddresses Array of SRTSourceAddressResp The SRT peer address.
Note: This field may return null, indicating that no valid value can be obtained.

DescribeOutput

Configuration information of the queried output.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo.

Name Type Description
OutputId String Output ID.
OutputName String Output name.
OutputType String Output type.
Description String Output description.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Output protocol.
OutputAddressList Array of OutputAddress Output destination address information list.
OutputRegion String Output region.
Note: this field may return null, indicating that no valid values can be obtained.
SRTSettings DescribeOutputSRTSettings SRT configuration information of output.
Note: this field may return null, indicating that no valid values can be obtained.
RTPSettings DescribeOutputRTPSettings RTP configuration information of output.
Note: this field may return null, indicating that no valid values can be obtained.
RTMPSettings DescribeOutputRTMPSettings RTMP configuration information of output.
Note: this field may return null, indicating that no valid values can be obtained.
RTMPPullSettings DescribeOutputRTMPPullSettings RTMP pull configuration of the output
Note: This field may return null, indicating that no valid value was found.
AllowIpList Array of String CIDR allowlist
This parameter is valid if Protocol is set to RTMP_PULL. If this parameter is left empty, there is no restriction on clients’ IP addresses.
Note: This field may return null, indicating that no valid value was found.
RTSPPullSettings DescribeOutputRTSPPullSettings Output RTSP pull stream configuration.
HLSPullSettings DescribeOutputHLSPullSettings Output HLS pull stream configuration.
MaxConcurrent Integer Maximum pull stream concurrency, maximum 4, default 4.
SecurityGroupIds Array of String The bound security group IDs.

DescribeOutputHLSPullServerUrl

Query output HLS pull stream URL information.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Url String The Url of the HLS pull stream address.

DescribeOutputHLSPullSettings

Query the output HLS pull stream configuration.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
ServerUrls Array of DescribeOutputHLSPullServerUrl HLS pull stream address list.

DescribeOutputRTMPPullServerUrl

RTMP pull URL of the output

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
TcUrl String tcUrl of the RTMP pull URL
StreamKey String Stream key of the RTMP pull URL

DescribeOutputRTMPPullSettings

RTMP pull configuration of the output

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
ServerUrls Array of DescribeOutputRTMPPullServerUrl List of pull URLs
Note: This field may return null, indicating that no valid value was found.

DescribeOutputRTMPSettings

RTMP configuration information of the queried output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
IdleTimeout Integer Idle timeout period.
Note: this field may return null, indicating that no valid values can be obtained.
ChunkSize Integer Chunk size.
Note: this field may return null, indicating that no valid values can be obtained.
Destinations Array of RTMPAddressDestination Destination address information list of RTMP push.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeOutputRTPSettings

RTP configuration information of the queried output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Destinations Array of RTPAddressDestination Destination address information list of RTP push.
Note: this field may return null, indicating that no valid values can be obtained.
FEC String Whether it is FEC.
Note: this field may return null, indicating that no valid values can be obtained.
IdleTimeout Integer Idle timeout period.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeOutputRTSPPullServerUrl

Query output RTSP pull stream URL information.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Url String RTSP pull stream address Url.

DescribeOutputRTSPPullSettings

Query output RTSP pull stream configuration information.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
ServerUrls Array of DescribeOutputRTSPPullServerUrl RTSP pull stream address list.

DescribeOutputSRTSettings

SRT configuration information of the queried output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Destinations Array of SRTAddressDestination A list of the destination addresses for relay. This parameter is valid if Mode is CALLER.
Note: This field may return null, indicating that no valid value can be obtained.
StreamId String Stream ID.
Note: this field may return null, indicating that no valid values can be obtained.
Latency Integer Latency.
Note: this field may return null, indicating that no valid values can be obtained.
RecvLatency Integer Receive latency.
Note: this field may return null, indicating that no valid values can be obtained.
PeerLatency Integer Peer latency.
Note: this field may return null, indicating that no valid values can be obtained.
PeerIdleTimeout Integer Peer idle timeout period.
Note: this field may return null, indicating that no valid values can be obtained.
Passphrase String Encryption key.
Note: this field may return null, indicating that no valid values can be obtained.
PbKeyLen Integer Encryption key length.
Note: this field may return null, indicating that no valid values can be obtained.
Mode String The SRT mode.
Note: This field may return null, indicating that no valid value can be obtained.
SourceAddresses Array of OutputSRTSourceAddressResp The server’s listen address, which is valid if Mode is LISTENER.
Note: This field may return null, indicating that no valid value can be obtained.

DescribeRTMPPullSourceAddress

Query the input RTMP configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Description
TcUrl String The TcUrl address of the RTMP origin server.
StreamKey String The StreamKey of the RTMP origin server.

The concatenation rule for the RTMP origin server address is: $TcUrl/$StreamKey.

DescribeRTSPPullSourceAddress

Query the input RTSP configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Url String The Url address of the RTSP origin server.

FlowAudio

The audio data of the flow.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
Fps Integer The frame rate.
Rate Integer The bitrate (bps).
Pid Integer The audio PID.

FlowLogInfo

The logs of a flow.

Used by actions: DescribeStreamLinkFlowLogs.

Name Type Description
Timestamp Integer The timestamp (seconds).
Type String Whether it is an input or output.
InputOutputId String The input or output ID.
Protocol String The protocol.
EventCode String The event code.
EventMessage String The event information.
RemoteIp String The peer IP.
RemotePort String The peer port.
Pipeline String Whether it is a primary or backup pipeline. Valid values: 0 (primary), 1 (backup).
InputOutputName String The input or output name.

FlowMediaAudio

The audio data of a flow.

Used by actions: DescribeStreamLinkFlowMediaStatistics.

Name Type Description
Fps Integer The frame rate.
Rate Integer The bitrate (bps).
Pid Integer The audio PID.
SessionId String The ID of a push session.

FlowMediaInfo

The media data of a flow.

Used by actions: DescribeStreamLinkFlowMediaStatistics.

Name Type Description
Timestamp Integer The timestamp (seconds).
Network Integer The total bandwidth.
Video Array of FlowMediaVideo The video data of the flow.
Audio Array of FlowMediaAudio The audio data of the flow.
SessionId String The ID of a push session.
ClientIp String The client IP.

FlowMediaVideo

The video data of a flow.

Used by actions: DescribeStreamLinkFlowMediaStatistics.

Name Type Description
Fps Integer The frame rate.
Rate Integer The bitrate (bps).
Pid Integer The video PID.
SessionId String The ID of a push session.

FlowRealtimeStatusCommon

The common real-time status information of a flow.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
State String The connection status. Valid values: Connected, Waiting, Idle.
Mode String The connection mode. Valid values: Listener, Caller.
ConnectedTime Integer The connected time.
Bitrate Integer The real-time bitrate (bps).
Reconnections Integer The number of retries.

FlowRealtimeStatusItem

The real-time status information of a flow.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
Type String Whether it is an input or output. Valid values: Input, Output.
InputId String The input ID, which is not empty if Type is Input.
OutputId String The output ID, which is not empty if Type is Output.
FlowId String The flow ID.
Protocol String The protocol used. Valid values: SRT, RTP, RTMP.
CommonStatus FlowRealtimeStatusCommon The common status information.
SRTStatus FlowRealtimeStatusSRT This parameter is returned if Protocol is SRT.
Note: This field may return null, indicating that no valid value can be obtained.
RTMPStatus FlowRealtimeStatusRTMP This parameter is returned if Protocol is RTMP.
Note: This field may return null, indicating that no valid value can be obtained.
ConnectServerIP String The server IP.
RTPStatus FlowRealtimeStatusRTP This parameter is returned if the RTP protocol is used.
Note: This field may return null, indicating that no valid value can be obtained.

FlowRealtimeStatusRTMP

The real-time RTMP streaming information of a flow.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
VideoFPS Integer The video frame rate.
AudioFPS Integer The audio frame rate.

FlowRealtimeStatusRTP

The real-time RTP streaming information of a flow.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
Packets Integer The number of packets transmitted.

FlowRealtimeStatusSRT

The real-time SRT streaming information of a flow.

Used by actions: DescribeStreamLinkFlowRealtimeStatus.

Name Type Description
Latency Integer The latency (ms).
RTT Integer RTT (ms).
Packets Integer The number of packets sent or received.
PacketLossRate Float The packet loss rate.
RetransmitRate Float The retransmission rate.
DroppedPackets Integer The number of packets dropped.
Encryption String Whether to encrypt the stream. Valid values: On, Off.

FlowSRTInfo

The SRT streaming performance data.

Used by actions: DescribeStreamLinkFlowSRTStatistics.

Name Type Description
Timestamp Integer The timestamp (seconds).
SendPacketLossRate Integer The packet loss rate for sending.
SendRetransmissionRate Integer The retry rate for sending.
RecvPacketLossRate Integer The packet loss rate for receiving.
RecvRetransmissionRate Integer The retry rate for receiving.
RTT Integer The peer RTT.
SessionId String The ID of a push session.
SendPacketDropNumber Integer The number of dropped packets for sending.
RecvPacketDropNumber Integer The number of dropped packets for receiving.

FlowStatistics

The flow statistics.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
SessionId String The session ID.
ClientIp String The peer IP.
Network Integer The total bandwidth.
Video Array of FlowVideo The video data.
Audio Array of FlowAudio The audio data.

FlowStatisticsArray

A list of the flow statistics.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
Timestamp Integer The timestamp.
FlowStatistics Array of FlowStatistics The statistics of all the sessions.

FlowVideo

The video data of a flow.

Used by actions: DescribeStreamLinkFlowStatistics.

Name Type Description
Fps Integer The frame rate.
Rate Integer The bitrate (bps).
Pid Integer The audio PID.

HLSPullSourceAddress

Created input HLS pull stream origin server configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Url String Yes The Url of the HLS origin server.

InputAddress

Input address information.

Used by actions: ModifyStreamLinkInput.

Name Type Description
Ip String Input address IP.
Port Integer Input address port.

ModifyInput

The new input configuration.

Used by actions: ModifyStreamLinkInput.

Name Type Required Description
InputId String Yes The input ID.
InputName String Yes The input name.
Description String Yes The description of the input.
AllowIpList Array of String Yes The IP addresses (CIDR) allowed to push streams.
SRTSettings CreateInputSRTSettings Yes The SRT configuration information.
RTPSettings CreateInputRTPSettings Yes The RTP configuration information.
Protocol String No The input protocol. Valid values: SRT, RTP, RTMP.
If there is an RTP input, the output must be RTP.
If there is an RTMP input, the output must be SRT or RTMP.
If there is an SRT input, the output must be SRT.
FailOver String No Whether to enable input failover. Valid values: OPEN, CLOSE.
RTMPPullSettings CreateInputRTMPPullSettings No Configuration information for RTMP_PULL.
RTSPPullSettings CreateInputRTSPPullSettings No Configuration information of RTSP_PULL.
HLSPullSettings CreateInputHLSPullSettings No HLS_PULL configuration information.
ResilientStream ResilientStreamConf No Delayed broadcast smooth streaming configuration information.
SecurityGroupIds Array of String No The ID of the input security group to bind. Only one security group can be associated.
Zones Array of String No Availability zone, optional, supports up to two availability zones. For interfaces that need to be changed, the second availability zone will participate in resource allocation. This is effective if disaster recovery is enabled for input or RTSP_PULL protocol switching is involved (addresses will be reallocated).

ModifyOutputInfo

The new output configuration.

Used by actions: ModifyStreamLinkOutputInfo.

Name Type Required Description
OutputId String Yes The ID of the output to modify.
OutputName String Yes The output name.
Description String Yes The description of the output.
Protocol String Yes The output protocol. Valid values: SRT, RTP, RTMP.
SRTSettings CreateOutputSrtSettings No The SRT relay configuration.
RTPSettings CreateOutputInfoRTPSettings No The RTP relay configuration.
RTMPSettings CreateOutputRTMPSettings No The RTMP relay configuration.
AllowIpList Array of String No IP whitelist, in CIDR format, such as 0.0.0.0/0. This is valid when Protocol is RTMP_PULL, and empty means no restriction on client IP.
MaxConcurrent Integer No The maximum number of concurrent stream pulls is 4, and the default value is 4.
SecurityGroupIds Array of String No The bound security group IDs.

OutputAddress

Output destination address.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String Output destination IP.

OutputSRTSourceAddressResp

The listen address for an SRT output.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Required Description
Ip String Yes The listen IP.
Port Integer Yes The listen port.

RTMPAddressDestination

Destination address information of RTMP push.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Url String Destination URL of RTMP push in the format of 'rtmp://domain/live'.
StreamKey String Destination StreamKey of RTMP push in the format of 'streamid?key=value'.

RTMPPullSourceAddress

Created input RTMP pull stream origin server configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
TcUrl String Yes The TcUrl address of the RTMP origin server.
StreamKey String Yes The StreamKey of the RTMP origin server.

RTPAddressDestination

Destination address information of RTP push.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String Push destination address IP.
Port Integer Push destination address port.

RTSPPullSourceAddress

Created input RTSP pull stream origin server configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Url String Yes The Url address of the RTSP origin server.

RegionInfo

Region information

Used by actions: DescribeStreamLinkRegions.

Name Type Description
Name String Region name

ResilientStreamConf

Delayed broadcast smooth stream delivery configuration.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Enable Boolean No Whether to enable delayed broadcast smooth stream delivery: true to enable, false to disable. It is disabled by default.
BufferTime Integer No Delayed broadcast duration, in seconds. Supported range: 10 to 300 seconds.

SRTAddressDestination

Push destination address information.

Used by actions: CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo.

Name Type Description
Ip String Destination address IP.
Port Integer Destination address port.

SRTSourceAddressReq

The SRT input address.

Used by actions: CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput.

Name Type Required Description
Ip String Yes The peer IP.
Port Integer Yes The peer port.

SRTSourceAddressResp

The SRT input address.

Used by actions: ModifyStreamLinkInput.

Name Type Required Description
Ip String Yes The peer IP.
Port Integer Yes The peer port.

StreamLinkRegionInfo

StreamLink region information

Used by actions: DescribeStreamLinkRegions.

Name Type Description
Regions Array of RegionInfo List of StreamLink regions

帮助和支持

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

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

文档反馈