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
ドキュメントAPIsBusiness IntelligenceData Types

Data Types

フォーカスモード
フォントサイズ
最終更新日: 2026-03-19 19:09:30

ApplyEmbedTokenInfo

Token deferral request

Used by actions: ApplyEmbedInterval.

Name Type Description
Result Boolean Request result.
Note: This field may return null, indicating that no valid values can be obtained.

BaseStateAction

Operation attributes of every record returned by a list query

Used by actions: DescribeDatasourceList.

Name Type Required Description
ShowEdit Boolean No Whether the edit button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
IsEdit Boolean No Whether the edit button is clickable.
Note: This field may return null, indicating that no valid values can be obtained.
EditText String No Edit button text.
Note: This field may return null, indicating that no valid values can be obtained.
EditTips String No Edit-disabled hint.
Note: This field may return null, indicating that no valid values can be obtained.
ShowDel Boolean No Whether the deletion button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
IsDel Boolean No Whether the deletion button is clickable.
Note: This field may return null, indicating that no valid values can be obtained.
DelText String No Delete button text.
Note: This field may return null, indicating that no valid values can be obtained.
DelTips String No Delete-disabled hint.
Note: This field may return null, indicating that no valid values can be obtained.
ShowCopy Boolean No Whether the copy button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
ShowView Boolean No Whether it is visible.
Note: This field may return null, indicating that no valid values can be obtained.
ShowRename Boolean No Whether renaming is allowed.
Note: This field may return null, indicating that no valid values can be obtained.

CorpUserListData

Enterprise user list

Used by actions: DescribeUserProjectList.

Name Type Description
List Array of UserIdAndUserName List.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.
TotalPages Integer Number of pages.

Data

Data

Used by actions: CreateProject.

Name Type Description
Id Integer Project ID.
EditUrl String url
Note: This field may return null, indicating that no valid values can be obtained.

DataId

Data ID

Used by actions: CreateUserRole, CreateUserRoleProject.

Name Type Description
Id Integer Data ID.
Note: This field may return null, indicating that no valid values can be obtained.

DatasourceInfo

Data source details

Used by actions: DescribeDatasourceList.

Name Type Description
Id Integer Database ID.
DbName String Database name.
ServiceType String Domain type. Valid values: 1: Tencent Cloud; 2: local.
Note: This field may return null, indicating that no valid values can be obtained.
SourceName String Database alias.
DbType String Database driver.
DbHost String HOST
DbPort Integer Port.
DbUser String Username.
Charset String Database encoding.
CreatedAt String Creation time.
UpdatedAt String Modification time.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
Catalog String Catalog value.
Note: This field may return null, indicating that no valid values can be obtained.
ConnectType String Connection type.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
Desc String Data source description.
Note: This field may return null, indicating that no valid values can be obtained.
Status String Data source status.
Note: This field may return null, indicating that no valid values can be obtained.
SourcePlat String Source platform.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraParam String Extension parameter.
Note: This field may return null, indicating that no valid values can be obtained.
AddInfo String Additional information.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
EngineType String Engine type.
Note: This field may return null, indicating that no valid values can be obtained.
Manager String Data source owner.
Note: This field may return null, indicating that no valid values can be obtained.
OperatorWhitelist String Operation personnel allowlist.
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String VPC information of the data source.
Note: This field may return null, indicating that no valid values can be obtained.
UniqVpcId String uniqVpc information of the data source.
Note: This field may return null, indicating that no valid values can be obtained.
RegionId String Data source region information.
Note: This field may return null, indicating that no valid values can be obtained.
StateAction BaseStateAction Operation attributes.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
PermissionList Array of PermissionGroup Permission list.
Note: This field may return null, indicating that no valid values can be obtained.
AuthList Array of String Permission value list.
Note: This field may return null, indicating that no valid values can be obtained.
DataOrigin String Third-party data source identifier.
Note: This field may return null, indicating that no valid values can be obtained.
DataOriginProjectId String Third-party project ID.
Note: This field may return null, indicating that no valid values can be obtained.
DataOriginDatasourceId String Third-party data source ID.
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.
DbTypeName String Data source name.
Note: This field may return null, indicating that no valid values can be obtained.
UseVPC Boolean Enable VPC.
Note: This field may return null, indicating that no valid values can be obtained.
Owner String Associated person ID.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerName String Associated person name.
Note: This field may return null, indicating that no valid values can be obtained.
Schema String Database schema.
Note: This field may return null, indicating that no valid values can be obtained.
DbVersion String Database version.
Note: This field may return null, indicating that no valid values can be obtained.

DatasourceInfoData

Data source details list

Used by actions: DescribeDatasourceList.

Name Type Description
List Array of DatasourceInfo Data source details list.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.
Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer Total number of pages.
Note: This field may return null, indicating that no valid values can be obtained.

EmbedTokenInfo

Report embedding data structure with strong authentication

Used by actions: CreateEmbedToken.

Name Type Description
Id Integer Information identifier.
Note: This field may return null, indicating that no valid values can be obtained.
BIToken String Token.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
PageId String Page ID.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraParam String Backup.
Note: This field may return null, indicating that no valid values can be obtained.
Scope String Embedding type.
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Expiration time (in minutes), with a maximum value of 240.
Note: This field may return null, indicating that no valid values can be obtained.
UserCorpId String User enterprise ID (only used for multi-user).
Note: This field may return null, indicating that no valid values can be obtained.
UserId String User ID (only used for multi-user).
Note: This field may return null, indicating that no valid values can be obtained.
TicketNum Integer Access count limit (range: 1–99999). Leave empty to disable access restrictions.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalParam String Global parameter.
Note: This field may return null, indicating that no valid values can be obtained.
Intention String "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.
Note: This field may return null, indicating that no valid values can be obtained.
TokenType Integer 100: no bound user.
200: single token per user.
300: multiple tokens per user.
Note: This field may return null, indicating that no valid values can be obtained.
TokenNum Integer Number of tokens.
Note: This field may return null, indicating that no valid values can be obtained.
SingleUserMultiToken Boolean Whether it is multiple tokens per user.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigParam String Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.
Note: This field may return null, indicating that no valid values can be obtained.

ErrorInfo

Custom error information object

Used by actions: ApplyEmbedInterval, ClearEmbedToken, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreateProject, CreateUserRole, CreateUserRoleProject, DeleteDatasource, DeleteProject, DeleteUserRole, DeleteUserRoleProject, DescribeDatasourceList, DescribePageWidgetList, DescribeProjectInfo, DescribeProjectList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, ExportScreenPage, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyUserRole, ModifyUserRoleProject.

Name Type Description
ErrorTip String Error description field.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage String Original exception message.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorLevel String Error level field.
ERROR
WARN
INFO
Note: This field may return null, indicating that no valid values can be obtained.
DocLink String Documentation link.
Note: This field may return null, indicating that no valid values can be obtained.
FAQ String Quick start guide.
Note: This field may return null, indicating that no valid values can be obtained.
ReservedField String Reserved field 1.
Note: This field may return null, indicating that no valid values can be obtained.

IdDTO

Object containing only ID

Used by actions: CreateDatasource, CreateDatasourceCloud.

Name Type Required Description
Id Integer Yes Request ID.
Note: This field may return null, indicating that no valid values can be obtained.
AccessKey String No key
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer No id
Note: This field may return null, indicating that no valid values can be obtained.
TranId String No Transaction ID.
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer No Transaction status.
Value range:.
Processing.
2: processing is successful.
3: processing failure.
Note: This field may return null, indicating that no valid values can be obtained.

PageScreenListVO

Screenshot list

Used by actions: ExportScreenPage.

Name Type Description
PicType String Image export type. Valid values: Base64, and URL.
Note: This field may return null, indicating that no valid values can be obtained.
List Array of PageScreenVO Image list.
Note: This field may return null, indicating that no valid values can be obtained.
TranId String Async transaction ID.
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer Transaction status.
1: processing; 2: processing successful; 3: processing failed (error content in outer Msg).
Note: This field may return null, indicating that no valid values can be obtained.

PageScreenVO

Page screenshot information

Used by actions: ExportScreenPage.

Name Type Description
Content String Screenshot Base64 or URL.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetId String Component ID.
Note: This field may return null, indicating that no valid values can be obtained.

PermissionComponent

Business edition permission unit

Used by actions: DescribeDatasourceList.

Name Type Required Description
ModuleId String No Permission value.
Note: This field may return null, indicating that no valid values can be obtained.
IncludeType String No Availability.
Valid values:.

-usable.
-visible.
-disabled: unavailable.
-hidden: hide.

Default value: disabled.
Example value: disabled.
Note: This field may return null, indicating that no valid values can be obtained.
UpgradeVersionType String No Target upgrade version.
Note: This field may return null, indicating that no valid values can be obtained.
Tips String No Supplemental information.
Note: This field may return null, indicating that no valid values can be obtained.
TipsKey String No Key for supplementary information.
Note: This field may return null, indicating that no valid values can be obtained.

PermissionGroup

Commercial version permission grouping

Used by actions: DescribeDatasourceList.

Name Type Required Description
ModuleGroup String No Group name.
Note: This field may return null, indicating that no valid values can be obtained.
Components Array of PermissionComponent No Permission list.
Note: This field may return null, indicating that no valid values can be obtained.

Project

Project description

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Description
Id Integer Project ID.
Logo String Project logo.
Note: This field may return null, indicating that no valid values can be obtained.
Name String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
ColorCode String Background color of the logo.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
MemberCount Integer Number of members.
Note: This field may return null, indicating that no valid values can be obtained.
PageCount Integer Number of pages.
Note: This field may return null, indicating that no valid values can be obtained.
LastModifyName String Last modified report and dashboard names.
Note: This field may return null, indicating that no valid values can be obtained.
Source String ""
Note: This field may return null, indicating that no valid values can be obtained.
Apply Boolean ""
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String ""
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String ""
Note: This field may return null, indicating that no valid values can be obtained.
CorpId String ""
Note: This field may return null, indicating that no valid values can be obtained.
Mark String ""
Note: This field may return null, indicating that no valid values can be obtained.
Seed String ""
Note: This field may return null, indicating that no valid values can be obtained.
AuthList Array of String Permission list in the project.
Note: This field may return null, indicating that no valid values can be obtained.
PanelScope String Default dashboard.
Note: This field may return null, indicating that no valid values can be obtained.
IsExternalManage Boolean Whether it is managed.
Note: This field may return null, indicating that no valid values can be obtained.
ManagePlatform String Management platform name.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigList Array of ProjectConfigList Customization parameter.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUserName String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
Owner String Associated person ID.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerName String Associated person.
Note: This field may return null, indicating that no valid values can be obtained.
NormalCount Integer Number of dashboard pages.
Note: This field may return null, indicating that no valid values can be obtained.
FreeCount Integer Number of free canvas pages.
Note: This field may return null, indicating that no valid values can be obtained.
AdhocCount Integer Number of ad-hoc analysis pages.
Note: This field may return null, indicating that no valid values can be obtained.
BriefingCount Integer Number of pages in the briefing
Note: This field may return null, indicating that no valid values can be obtained.

ProjectConfigList

Customized query

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Required Description
ModuleGroup String No Module group.
Note: This field may return null, indicating that no valid values can be obtained.
Components Array of ProjectConfigResult No Content.
Note: This field may return null, indicating that no valid values can be obtained.

ProjectConfigResult

Customized query

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Required Description
ModuleId String No Configuration name.
Note: This field may return null, indicating that no valid values can be obtained.
IncludeType String No Configuration mode.
Valid values:.

-usable.
-visible.
-disabled: unavailable.
-hidden: hide.

Default value: disabled.
Example value: disabled.
Note: This field may return null, indicating that no valid values can be obtained.
Params String No Additional parameters.
Note: This field may return null, indicating that no valid values can be obtained.

ProjectListData

Project list data

Used by actions: DescribeProjectList.

Name Type Description
List Array of Project Array.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.

Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer 1
Note: This field may return null, indicating that no valid values can be obtained.

UserGroupDTO

User group

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Required Description
Id Integer No id
Note: This field may return null, indicating that no valid values can be obtained.
GroupName String No User group name.
Note: This field may return null, indicating that no valid values can be obtained.
ParentId Integer No Parent node ID.
Note: This field may return null, indicating that no valid values can be obtained.
IsDefault Integer No Whether it is default.
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserId String No Administrator user ID.
Note: This field may return null, indicating that no valid values can be obtained.
Description String No Description.
Note: This field may return null, indicating that no valid values can be obtained.
Location Integer No Location.
Note: This field may return null, indicating that no valid values can be obtained.

UserIdAndUserName

User ID and username

Used by actions: DescribeUserProjectList.

Name Type Required Description
UserId String No User ID.
UserName String No Username.
CorpId String No Enterprise ID.
Note: This field may return null, indicating that no valid values can be obtained.
Email String No Email.
Note: This field may return null, indicating that no valid values can be obtained.
LastLogin Timestamp ISO8601 No Last login time.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer No User status.
Valid values:.

-Enable.
-0: disabled.

The default value is 1.
Example value: 1.
Note: This field may return null, indicating that no valid values can be obtained.
FirstModify Integer No Whether to change password on first login.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String No Mobile number.
Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String No Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String No Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt Timestamp ISO8601 No Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String No Modifier.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt Timestamp ISO8601 No Change time.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalUserName String No System global role.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalUserCode String No System global role code.
Note: This field may return null, indicating that no valid values can be obtained.
Mobile String No Mobile number.

Note: This field may return null, indicating that no valid values can be obtained.
AppId String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserAliasName String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String No 1
Note: This field may return null, indicating that no valid values can be obtained.
InValidateAppRange Boolean No 1
Note: This field may return null, indicating that no valid values can be obtained.
EmailActivationStatus Integer No -1: No activation required. 0: Inactivated. 1: Activated. Null value represents pending binding.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer No 1
Note: This field may return null, indicating that no valid values can be obtained.

UserInfo

User ID and username

Used by actions: CreateUserRole, CreateUserRoleProject.

Name Type Required Description
UserId String No User ID.
UserName String No Username.
Email String No Email.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String No Mobile number.

Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String No Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String No WeCom account ID.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String No WeCom account name.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListData

User role information

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
Total Integer Total number.
Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer Total number of pages.
Note: This field may return null, indicating that no valid values can be obtained.
List Array of UserRoleListDataUserRoleInfo List.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListDataRoleInfo

Role information of the user role list

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
RoleName String Role Name.
Note: This field may return null, indicating that no valid values can be obtained.
RoleId Integer Role ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
ScopeType Integer Whether it is a global role (0: no; 1: yes).
Note: This field may return null, indicating that no valid values can be obtained.
ModuleCollection String Role key.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListDataUserRoleInfo

User role information

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
Id Integer Business ID.
RoleList Array of UserRoleListDataRoleInfo This API is used to obtain the role list.
Note: This field may return null, indicating that no valid values can be obtained.
RoleIdList Array of Integer Role ID list.
Note: This field may return null, indicating that no valid values can be obtained.
UserId String User ID.
UserName String Username.
CorpId String Enterprise ID.
Email String Email.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
LastLogin Timestamp ISO8601 Last login time.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Account status.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String Mobile number.
Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
RootAccount Boolean Whether it is the root account.
Note: This field may return null, indicating that no valid values can be obtained.
CorpAdmin Boolean Whether it is an enterprise administrator.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String WeCom user ID.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserAliasName String Nickname.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String Application username.
Note: This field may return null, indicating that no valid values can be obtained.
InValidateAppRange Boolean Whether it is within the visible range.
Note: This field may return null, indicating that no valid values can be obtained.
AppOpenUserId String User openID.
Note: This field may return null, indicating that no valid values can be obtained.
EmailActivationStatus Integer Activation status of email.
Note: This field may return null, indicating that no valid values can be obtained.
UserGroupList Array of UserGroupDTO User group information.
Note: This field may return null, indicating that no valid values can be obtained.

WidgetListVO

Page component information

Used by actions: DescribePageWidgetList.

Name Type Description
CorpId String uin
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
PageId String Page ID.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetList Array of WidgetVO Component array.
Note: This field may return null, indicating that no valid values can be obtained.

WidgetVO

Component information

Used by actions: DescribePageWidgetList.

Name Type Description
WidgetId String Component ID.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetName String Component name.
Note: This field may return null, indicating that no valid values can be obtained.
前の記事へ: DescribeDatasourceList次の記事へ: Error Codes

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック