DocsICP FilingConsole
Documentation
Home Page AI Guardrails Content Moderation 1.0 Developer Reference API Reference (Configuration Management) API overview

API overview

Updated at:
Copy as MD
Product
My Favorites

API standards and multilingual preset SDKs

The OpenAPI of this product (Green/2017-08-23) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

API catalog

API

Title

Description
AuditItemSubmit Submit a review job Submits the results of a manual review.
CreatCustomOcrTemplate Create a custom OCR template Creates an OCR template.
CreateAuditCallback Create a moderation callback Creates a callback configuration, including the callback method, callback URL, and event type.
CreateBizType Create a business type Creates a business scenario.
CreateCallback Create a callback Creates a message notification.
CreateImageLib Create a custom image library Creates an image library.
CreateKeyword Add text to a specified text library Adds keywords.
CreateKeywordLib Create a custom text library Creates a text library.
CreateOssStockTask Create an OSS stock scanning task Creates a stock scanning task.
CreateWebsiteIndexPageBaseline Create a website index page baseline Creates a baseline for the site homepage.
DeleteAuditCallback Delete Audit Callback Delete self-service moderation message notification
DeleteBizType Delete a business type Deletes a business scenario.
DeleteCallback Delete a callback Deletes a message notification.
DeleteCustomOcrTemplate Delete a custom OCR template Deletes an OCR template.
DeleteImageFromLib Delete a specified image from the image library Deletes an image from the image library.
DeleteImageLib Delete a custom image library Deletes an image library.
DeleteKeyword Delete text from a text library Deletes keywords.
DeleteKeywordLib Delete a custom text library Deletes a text library.
DescribeAppInfo Query application information Queries the information of an application.
DescribeAuditCallback Get moderation callback Queries the callback configuration.
DescribeAuditCallbackList Query content moderation callback list Queries the list of callback configurations that match the specified query conditions.
DescribeAuditContent Query moderation content Queries the list of self-service moderation content.
DescribeAuditContentItem Query content moderation result details Queries the details of content moderation results.
DescribeAuditRange Get audit scope Queries the audit scope.
DescribeAuditSetting Get audit settings Queries the audit configuration.
DescribeBizTypeAuditRange Retrieve the moderation scope of a business type The type of data that flows into self-service moderation.
DescribeBizTypeImageLib Query image libraries by business type Queries the list of image libraries associated with a custom scenario.
DescribeBizTypeResultBackupSetting Retrieve business type backup settings Retrieves the evidence backup settings.
DescribeBizTypes List bizTypes Queries the list of business scenario BizTypes.
DescribeBizTypeSetting Retrieve business type settings Queries the machine-assisted moderation standards for a business scenario.
DescribeBizTypeTemplates Retrieve business type templates Queries the list of optional templates for OSS scan users.
DescribeBizTypeTextLib Retrieve text libraries for a business type Associates text libraries with a business scenario.
DescribeCallbackBind Retrieve callback binding information Retrieves the message notification configuration.
DescribeCallbackList Retrieve callback list Retrieves the list of message notifications.
DescribeCloudMonitorServices Retrieve cloudMonitor service Retrieves the concurrent detection service.
DescribeCustomOcrTemplate Query custom OCR templates Queries custom OCR templates of a user.
DescribeImageFromLib Query images in a custom image library Queries the list of images in a custom image library.
DescribeImageLib Query custom image library list Queries the list of custom image libraries.
DescribeImageUploadInfo Get image upload information Get image upload settings
DescribeKeyword Search for text in a specified text library Queries a list of keywords.
DescribeKeywordLib Query text library list Queries the list of text libraries.
DescribeNotificationSetting Get notification configuration Queries the notification settings for site monitoring.
DescribeOpenApiMonitorAlarmSetting Retrieve open API monitoring and alerting settings Retrieves the real-time monitoring and alerting settings for open APIs.
DescribeOpenApiMonitorData Retrieve API monitoring data Retrieves real-time monitoring data for machine-assisted moderation.
DescribeOpenApiRcpStats Retrieve open API call statistics Retrieves statistics on manual review data.
DescribeOpenApiUsage Retrieve usage statistics Retrieves usage statistics for machine-assisted moderation.
DescribeOssCallbackSetting Get OSS callback settings Queries the callback configuration for OSS incremental scanning.
DescribeOssConfiguration Describe OSS task configuration Retrieves the OSS scan task configuration.
DescribeOssIncrementCheckSetting Retrieve OSS incremental scan settings Retrieves the OSS incremental scan settings.
DescribeOssIncrementOverview Retrieve OSS incremental overview Queries the object information pending invoicing.
DescribeOssIncrementStats Query OSS incremental scan statistics Queries the statistics of incremental OSS scan data.
DescribeOssResultItems Query OSS violation detection results Queries OSS scan results.
DescribeOssStockScanTasks Query OSS stock scan tasks Queries the list of OSS stock scan tasks.
DescribeOssStockScanTaskStatData Retrieve OSS inventory scan status data Retrieves the scan result data of existing OSS objects.
DescribeOssStockScanUserStatus Retrieve OSS user status The OSS stock scan user status.
DescribeOssStockStatus Get OSS inventory status Retrieves the status of an OSS stock scan task.
DescribeOssStockTaskSetting Get OSS inventory task settings Retrieves the configuration of an existing inventory scan task.
DescribeUploadInfo Retrieve image information Retrieves the upload information for a text library.
DescribeUsageBill Get usage bill Queries the billing type of a user.
DescribeUserBizTypes Retrieve user business types Retrieves the business scenarios of a user.
DescribeUserOssBuckets Retrieve user buckets Retrieves the list of OSS buckets for a user.
DescribeUserStatus Retrieve user status information Retrieves the status of a user.
DescribeViewContent Retrieve view content Retrieves a list of detection results.
DescribeWebsiteIndexPageBaseline Retrieve website index page baseline Retrieves the baseline of a website index page.
DescribeWebsiteInstance Get website instances Queries site detection instances.
DescribeWebsiteInstanceId Get website instance Retrieves the website instance ID.
DescribeWebsiteInstanceKeyUrl Retrieve website instance key URL Retrieves the URL of a site instance.
DescribeWebsiteScanResult Get website scan results Queries website scan results.
DescribeWebsiteStat Get website status Retrieves the detection status of a website.
DescribeWebsiteVerifyInfo Retrieve website verification information Retrieves the verification information of a website.
ExportKeywords Export keywords Exports keywords.
ExportOpenApiRcpStats Export openAPI call statistics Exports OpenAPI call statistics.
ExportOpenApiUsage Export open API usage Exports detection results such as baseline check, resource usage, and load balancing status.
ExportOssResult Export OSS violation detection results as a file Exports OSS scan results.
GetAuditItemDetail Retrieve moderation content details The machine-assisted moderation result details.
GetAuditItemList Query moderation content list Queries the list of manual review results.
GetAuditUserConf Retrieve review status The console configuration information such as manual review settings.
ImportKeywords Import keywords Imports keywords.
MarkAuditContent Mark audit content Marks self-service audit results.
MarkOssResult Review and mark OSS violation detection results Marks OSS detection results.
ModifyAuditCallback Modify review callback Modifies the callback notification for manual review.
StopOssIncrementCheck Stop OSS incremental scan Stops an incremental scan task.
UpdateAuditCallback Update moderation callback Updates the callback configuration.
UpdateAuditRange Update audit scope Updates the audit scope.
UpdateBizType Update a business type Edits business scenario information.
UpdateBizTypeAuditRange Update business type approval Modifies the data types that flow into self-service content moderation.
UpdateBizTypeImageLib Update image library for business type Saves the associated image library configuration for a custom scenario.
UpdateBizTypeResultBackupSetting Update backup settings for a business type Modifies the evidence archiving settings.
UpdateBizTypeSetting Update business type settings Modifies the machine-assisted moderation standards for a business scenario.
UpdateBizTypeTextLib Update business type text library Modifies the text libraries associated with a business scenario.
UpdateCallback Update callback Updates a message callback.
UpdateCallbackBind Update callback Updates the bindng relationship of callback settings.
UpdateCustomOcrTemplate Update a custom OCR template Edits an OCR template.
UpdateImageLib Update image library name and parameters Updates the name and applicable bizTypes parameter of a custom image library.
UpdateKeywordLib Update custom text library information Updates a custom text library.
UpdateNotificationSetting Update notification settings Updates notification settings.
UpdateOssIncrementCheckSetting Update OSS incremental scan settings Updates the incremental scan configuration.
UpdateOssStockTask Update an existing OSS detection task Updates an existing OSS detection task.
UpdateWebsiteInstance Update a website instance Updates an instance.
UpdateWebsiteInstanceKeyUrl Update website instance keyUrl Updates the URL of a website instance.
UpdateWebsiteInstanceStatus Update website instance status Updates the instance status, such as unattaching, stopping, or running.
UploadImageToLib Add image metadata to a custom library Uploads images to an image library.
VerifyCustomOcrTemplate Verify a custom OCR template Tests an OCR template.
VerifyWebsiteInstance Verify a website instance Verifies domain name ownership.
Previous：API Reference (Configuration Management)Next：Endpoints