Home
UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
Appendix
This chapter introduces some relevant information that needs to be known when calling the WebService API.
objectinfo Parameters for Reviewing Cloud Service Stored Content in Asynchronous Mode
This chapter introduces the objectinfo configuration parameters for reviewing files stored in AWS, Alibaba Cloud, Swift, and Tencent Cloud services in asynchronous mode.

UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
- Overview
  Introduces Unified Content Web-Service Inspector (UCWI).
- Configure WebService API
  Introduces how to quickly configure the WebService API.
- Authentication
  Introduces the steps to obtain authentication information.
- GET-Get Channel List
  Introduces the interface call method for the Get Channel List interface.
- GET-Get Channel Details
  Introduces the interface call method for the Get Channel Details interface.
- GET-Get Incident List
  Introduces the invocation method of the Get Incident List interface.
- GET-Get Incident Details
  Introduces the interface call method for the Get Incident Details interface.
- GET-Get Policy Hit Statistics Report
  Introduces the interface call method for the Get Policy Hit Statistics Report.
- GET - Get Label
  Introduces the invocation method of the Get Label interface.
- POST -Add Label
  Introduces the invocation method of the Labeling interface.
- DELETE - Delete Label
  Introduces the interface invocation method of the Delete Label interface.
- POST-Content Review-Web Channel
  Introduces how to call the interface to perform security reviews on content in the Web channel.
- POST-Content Review-Email Channel
  Introduces how to call the interface to perform security reviews on content in the email channel.
- POST-Content Review-WebService Application Channel
  Introduces how to call the interface to perform security reviews of content in the WebService application channel.
- Data Masking Processing
  Introduces how to call the content review interface for data masking processing.
- POST-Virus Scan
  Introduces how to call the interface to perform virus scanning on text content.
- Upload Logs
  Introduction to the upload logs interface.
- Third-Party Log Management Platform Integration
  Introduces information about integrating with third-party log management platforms.
- Appendix
  This chapter introduces some relevant information that needs to be known when calling the WebService API.
  - objectinfo Parameters for Reviewing Cloud Service Stored Content in Asynchronous Mode
    This chapter introduces the objectinfo configuration parameters for reviewing files stored in AWS, Alibaba Cloud, Swift, and Tencent Cloud services in asynchronous mode.
  - Header File Examples
    Introduces the structure of the ucwi_config and ucwi_auth header files that need to be imported.

objectinfo Parameters for Reviewing Cloud Service Stored Content in Asynchronous Mode

This chapter introduces the objectinfo configuration parameters for reviewing files stored in AWS, Alibaba Cloud, Swift, and Tencent Cloud services in asynchronous mode.

AWS S3

Parameter Name	Type	Description
s3Region	String (Optional)	The region name when using s3. If running on EC2 and using AWS IAM role, the following three items accessKey, secretKey, endpointUrl can be omitted
accessKey	String (Optional)	The access key when using s3
secretKey	String (Optional)	The secret key when using s3
endpointUrl	String (Optional)	The endpoint URL when using s3
s3Bucket	String (Required)	The object bucket when using s3
s3Key	String (Required)	The object key (file name) when using s3

Swift OpenStack

Parameter Name	Type	Description
X-Auth-Token	String (Optional)	The authentication token when using swift. If a valid X-Auth-Token is provided, the following three items can be omitted
authUrl	String (Optional)	The authentication URL when using swift
X-Auth-User	String (Optional)	The authentication user when using swift
X-Auth-Key	String (Optional)	The authentication key (password) when using swift
objectUrl	String (Required)	The complete object access path when using swift

Alibaba Cloud OSS

Parameter Name	Type	Description
ossEndpoint	String (Optional)	The endpoint when using oss
accessKeyId	String (Optional)	The accessKeyId when using oss
accessKeySecret	String (Optional)	The accessKeySecret when using oss
ossBucket	String (Required)	The object bucket when using oss
ossKey	String (Required)	The object key (file name) when using oss

Tencent Cloud COS

Parameter Name	Type	Description
cosRegion	String (Required)	The region name when using cos
secretId	String (Required)	The secretId when using cos
secretKey	String (Required)	The secretKey when using cos
cosBucket	String (Required)	The object bucket when using cos
cosKey	String (Required)	The object key when using cos