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

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

Parameter Template 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

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

查询文本审核任务结果

聚焦模式

字号

最后更新时间： 2026-01-19 14:16:08

功能描述
DescribeAuditingTextJob 接口用于查询指定的文本审核任务。
说明：
 文本审核任务结果保存时效为3个月，您可通过本接口查询近3个月的审核结果。
请求
请求示例
GET /text/auditing/<jobId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
说明：
 Authorization: Auth String （详情请参见 请求签名 文档）。
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求体
该请求无请求体。
响应
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。
响应体
该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
  <JobsDetail>
    <Code>Success</Code>
    <Message>Success</Message>
    <DataId></DataId>
    <JobId></JobId>
    <State></State>
    <CreationTime></CreationTime>
    <Object></Object>
    <SectionCount></SectionCount>
    <Result>1</Result>
    <PornInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </PornInfo>
    <AdsInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </AdsInfo>
    <IllegalInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </IllegalInfo>
    <AbuseInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </AbuseInfo>
    </Section>
        <StartByte></StartByte>
        <PornInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AdsInfo>
        <IllegalInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </IllegalInfo>
        <AbuseInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AbuseInfo>
    </Section>
    </Section>
        <StartByte></StartByte>
        <PornInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AdsInfo>
        <IllegalInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </IllegalInfo>
        <AbuseInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AbuseInfo>
    </Section>
  </JobsDetail>
  <RequestId></RequestId>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
JobsDetail
Response
任务的详细信息
Container
RequestId
Response
每次请求发送时，服务端将会自动为请求生成一个 ID，遇到问题时，该 ID 能更快地协助定位问题
String
Container 节点 JobsDetail 的内容：
节点名称（关键字）
父节点
描述
类型
Code
Response.JobsDetail
错误码，只有 State 为 Failed 时返回，详情请查看 错误码列表。
String
Message
Response.JobsDetail
错误描述，只有 State 为 Failed 时返回。
String
DataId
Response.JobsDetail
该字段在审核结果中会返回原始内容，长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
String
JobId
Response.JobsDetail
本次审核任务的 ID。
String
State
Response.JobsDetail
任务的状态，值为 Submitted（已提交审核）、Success（审核成功）、Failed（审核失败）、Auditing（审核中）其中一个。
String
CreationTime
Response.JobsDetail
任务的创建时间。
String
Object
Response.JobsDetail
审核的对象名称，当创建任务使用 Object 时返回。
String
Content
Response.JobsDetail
文本内容的 Base64 编码。当创建任务使用 Content 时返回。
String
SectionCount
Response.JobsDetail
文本审核会将文本进行分段送审，每10000个 utf8 编码字符分一段，该参数表示分段的数量。
Integer
Label
Response.JobsDetail
该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告，以及其他不安全或不适宜的类型。
String
Result
Response.JobsDetail
该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。
有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。
Integer
PornInfo
Response.JobsDetail
审核场景为涉黄的审核结果信息。
Container
AdsInfo
Response.JobsDetail
审核场景为广告引导的审核结果信息。
Container
IllegalInfo
Response.JobsDetail
审核场景为违法的审核结果信息。
Container
AbuseInfo
Response.JobsDetail
审核场景为谩骂的审核结果信息。
Container
Section
Response.JobsDetail
具体文本分片的审核结果信息。
Container Array
UserInfo
Response.JobsDetail
用户业务字段。
Container
Container 节点 PornInfo，AdsInfo 的内容：
节点名称（关键字）
父节点
描述
类型
HitFlag
Response.JobsDetail.*Info
用于返回该审核场景的审核结果，返回值：
0：正常。
1：确认为当前场景的违规内容。
2：疑似为当前场景的违规内容。
Integer
Count
Response.JobsDetail.*Info
命中该审核分类的分片数。
Integer
Container 节点 Section 的内容：
节点名称（关键字）
父节点
描述
类型
StartByte
Response.JobsDetail.Section
该分片位于文本中的起始位置信息（即10代表第11个 utf8 文字）。从0开始。
Integer
Label
Response.JobsDetail.Section
该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告，以及其他不安全或不适宜的类型。
String
Result
Response.JobsDetail.Section
该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。
有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。
Integer
PornInfo
Response.JobsDetail.Section
审核场景为涉黄的审核结果信息。
Container
AdsInfo
Response.JobsDetail.Section
审核场景为广告引导的审核结果信息。
Container
IllegalInfo
Response.JobsDetail.Section
审核场景为违法的审核结果信息。
Container
AbuseInfo
Response.JobsDetail.Section
审核场景为谩骂的审核结果信息。
Container
Container 节点 PornInfo，AdsInfo，IllegalInfo，AbuseInfo 的内容：
节点名称（关键字）
父节点
描述
类型
HitFlag
Response.JobsDetail.Section.*Info
用于返回该审核场景的审核结果，返回值：
0：正常。
1：确认为当前场景的违规内容。
2：疑似为当前场景的违规内容。
Integer
Score
Response.JobsDetail.Section.*Info
该分片中审核的结果分数，分数越高表示越敏感。
Integer
Keywords
Response.JobsDetail.Section.*Info
在当前审核场景下命中的关键词，多关键词以,分隔。
String
Container 节点 UserInfo 的内容：
节点名称（关键字）
父节点
描述
类型
TokenId
Response.JobsDetail.UserInfo
用户业务 TokenId，长度不超过128字节。
String
Nickname
Response.JobsDetail.UserInfo
用户业务 Nickname，长度不超过128字节。
String
DeviceId
Response.JobsDetail.UserInfo
用户业务 DeviceId，长度不超过128字节。
String
AppId
Response.JobsDetail.UserInfo
用户业务 AppId，长度不超过128字节。
String
Room
Response.JobsDetail.UserInfo
用户业务 Room，长度不超过128字节。
String
IP
Response.JobsDetail.UserInfo
用户业务 IP，长度不超过128字节。
String
Type
Response.JobsDetail.UserInfo
用户业务 Type，长度不超过128字节。
String
错误码
此接口遵循统一的错误响应和错误码，详情请参见 错误码 文档。
实际案例
请求
GET /text/auditing/stb1ca9fc8a3ed11ea834c525400863904 HTTP/1.1
Accept: */*
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
响应
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
﻿
<Response>
  <JobsDetail>
﻿
    <JobId>st78925397b9de11eba532525400946f76</JobId>
    <State>Success</State>
    <CreationTime>2021-05-21T10:44:32+08:00</CreationTime>
    <Object>test.txt</Object>
    <SectionCount>1</SectionCount>
    <Label>Illegal</Label>
    <Result>1</Result>
    <PornInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </PornInfo>
    <AdsInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </AdsInfo>
    <IllegalInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </IllegalInfo>
    <AbuseInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </AbuseInfo>
    <Section>
        <StartByte>0</StartByte>
        <Label>Illegal</Label>
        <Result>1</Result>
        <PornInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </AdsInfo>
        <IllegalInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </IllegalInfo>
        <AbuseInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </AbuseInfo>
    </Section>
  </JobsDetail>
  <RequestId>xxxxxxxxxxxxxx</RequestId>
</Response>
﻿

帮助和支持

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

您也可以联系销售或提交工单以寻求帮助。

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

文档反馈

节点名称（关键字）	父节点	描述	类型
Response	无	保存结果的容器	Container

tencent cloud

APIs

查询文本审核任务结果

功能描述

请求

请求示例

请求头

请求体

响应

响应头

响应体

错误码

实际案例

请求

响应

帮助和支持