DocsICP FilingConsole
Documentation
Home Page AI Guardrails Guardrails 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/2022-09-26) 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
AddKeywordLib Add a keyword library Creates a keyword library.
DeleteFeatureConfig Delete feature configuration Delete feature configuration
ExportCipStats Export usage Exports call volume.
ExportOssCheckStat Export OSS scan task usage statistics Exports OSS usage statistics.
GetCipStats Query usage statistics Queries the call volume statistics.
GetFeatureConfig Query feature configurations Retrieves feature configurations.
GetOssCheckResultDetail Query OSS check result details Retrieves the detailed information of OSS check results.
GetOssCheckStat Query OSS usage statistics Queries OSS usage statistics.
GetScanResult Query detection results Queries the detection results.
GetServiceConf Get Rule Configuration Get a Single Service
GetServiceConfig Retrieve rule configuration Retrieves a single service.
GetUserBuyStatus Retrieve user purchase status Retrieves the purchase status of a user.
AddAnswerSample Add a proxy answer Adds a proxy answer.
AddAppAgent Add agent Adds an agent configuration to an app.
AddAppConfig Create a review agent configuration Creates an app configuration.
AddImageLib Create an image library Creates an image library.
AddImages2Lib Add images to an image library Adds images in batches.
AddKeywords Add keywords Adds keywords.
AddKeywordsToLib Add keywords to a thesaurus Adds keywords.
CancelStockOssCheckTask Cancel an OSS scan task Cancels an OSS scan task.
ConfirmAiAppScan Confirm activation of agent protection Confirms the activation of AI application protection.
CopyAppConfig Copy app configuration Copies an App configuration.
CopyServiceConfig Replication rule configuration Copies a service.
CreateAnswerLib Create a proxy answer library Creates a proxy answer library.
CreateAppConfig Create app configuration Creates an app configuration.
CreateCallback Create a message notification Creates a message notification.
CreateImageLib Create a custom image library Creates an image library.
CreateOnlineTest Create an online detection task Creates an online detection task.
CreatePreCheck Pre-check before creating an OSS scan task Performs a pre-check before creating an OSS scan task.
CreatStockOssCheckTask Create an OSS scan task Creates an OSS scan task.
DeleteAnswerLib Delete a proxy answer library Deletes a proxy answer library.
DeleteAnswerSample Delete proxy answers Deletes proxy answers.
DeleteAppAgent Delete agent configuration Deletes an agent configuration.
DeleteCallback Delete a message notification Deletes a message notification.
DeleteImagesFromLib Delete images from an image library Deletes images in batches.
DeleteKeyword Delete keywords Deletes keywords.
DeleteKeywordLib Delete a keyword library Deletes a keyword library.
DeleteOnlineTest Cancel an online test task Deletes an online detection task.
DescribeOnlineTestResult Query online moderation results Queries the detection results of online moderation.
DescribeOssV2Result Query OSS moderation results Retrieves OSS moderation results v2.
ExportAnswerSample Export proxy answer responses Exports proxy answer responses.
ExportKeyword Export keywords Exports keywords.
ExportResult Export OSS scan task results Exports OSS scan results.
ExportScanResult Export detection results Exports call results as an Excel file.
ExportTextScanResult Export text detection results Exports call results as an Excel file.
GetAiAppDetail Get agent details Retrieves the details of an AI application.
GetAiAppDetailStat Retrieve agent detail statistics Retrieves statistics for the details of an AI application.
GetAiAppDetailTopo Retrieve agent topology details Retrieves the topology of an AI application.
GetAiAppNodeDetail Get agent topology node details Retrieves the details of an application node in the agent topology.
GetAiAppOverview Retrieve agent overview Retrieves the overview information of AI applications.
GetAiAppStats Retrieve agent risk report statistics Retrieves statistics for AI application risk reports.
GetAiAppTraceDetail Get agent alert details Retrieves the details of an app alert.
GetAnswerImportProgress Retrieve proxy answer import progress Retrieves the import progress of proxy answer samples.
GetAppConfig Get app configuration Queries the details of an App configuration.
GetBackupBucketsList Retrieve bucket list for evidence dumping Retrieves the list of user buckets for evidence dumping.
GetBackupConfig Get Evidence Backup Configuration Get Evidence Backup Configuration
GetBackupStatus Query evidence archiving user status Verifies user authorization.
GetBucketsList List buckets Lists buckets.
GetExecuteTime Retrieve estimated execution time of a scheduled task Retrieves the estimated execution time of a scheduled task.
GetGuardLogStats Retrieve AI security guardrail log statistics Retrieves log statistics for AI security guardrails.
GetGuardStatus Get accessed state Retrieves statistics information on AI application protection data.
GetImageSceneLabelConf Retrieve image rule tag information Retrieves image rule tag information.
GetImageSceneLabelListConf Retrieve image rule tag information Retrieves image rule tag information.
GetJobNameList Query OSS scheduled scan detection cycle Queries the scheduled scan detection cycle for OSS.
GetKeywordImportResult Get keyword import result Queries the result of a keyword import task.
GetKeywordLib Retrieve keyword library information Retrieves the information about a keyword library.
GetOssCheckFreezeResult Query OSS scan and freeze results Queries the results of OSS scan and freeze operations.
GetOssCheckStatus Retrieve OSS detection status Retrieves the OSS detection user status.
GetOssCheckTaskInfo Retrieve OSS scan task information Queries the details of an OSS scan task.
GetPromptTestResult Retrieve custom prompt test results Tests the attribute configuration.
GetQpsStats QPS statistics Queries QPS statistics information.
GetRiskStats Query risk statistics Queries risk posture statistics.
GetScanNum Retrieve user pending detection information Queries the information about files pending detection for a user.
GetServiceLabelConfig Retrieve the tag configuration of a rule configuration Retrieves the tag configuration of a single service.
GetStockOssCheckTasksList Query OSS scan task list Queries the list of OSS scan tasks.
GetTextScanResult Query text detection results Queries the call results.
GetTuneProposalById Retrieve policy tuning results Retrieves tuning suggestions for switch configurations.
GetUploadContent Retrieve uploaded file content Retrieves the text content of an uploaded file.
GetUploadInfo Retrieve file upload information Retrieves the relevant information for file upload.
GetUploadLink Query upload URL Retrieves an upload URL.
InitAiAppScan Initialize agent protection Initializes AI application log scanning and activates the service.
ListAiAppByPage List agents by page Retrieves a paginated list of AI applications.
ListAiAppRiskEvent Query agent risk events Retrieves the list of risk events for an AI application.
ListAiAppRiskEventByPage List risk events with pagination Retrieves a paginated list of risk events for AI applications.
ListAiAppWarningByPage Query agent alerts by page Queries the alert list of an application with pagination.
ListAnswerLib List proxy answer libraries Queries the list of proxy answer libraries.
ListAppConfigHistory Retrieve app historical versions Retrieves the historical versions of an app.
ListAppConfigs Retrieve app list Retrieves the list of app configurations.
ListCallback List message notifications Queries the list of message notifications.
ListImageLib Query image libraries Queries the list of image libraries.
ListImagesFromLib List images in an image library Queries a paginated list of images.
ListKeywordLibs List keyword libraries Queries a list of keyword libraries.
ListKeywords Query keyword list Queries a list of keywords.
ListOssCheckResult Query OSS scan results Queries OSS scan results.
ListServiceConfigs Retrieve rule configuration list Retrieves the service list.
LlmStreamChat Large language model streaming conversation forwarding interface Calls a large language model in streaming mode using the SSE interface.
MarkOssV2Result Process OSS detection results Provides feedback on OSS detection results.
ModifyAnswerLib Edit proxy response library Updates a proxy response library.
ModifyAppAgent Modify agent configuration Modifies the agent configuration.
ModifyAppInfo Modify app information Modifies app information.
ModifyCallback Edit message notification Modifies a message notification.
ModifyFeatureConfig Edit attribute configuration Saves an attribute configuration.
ModifyServiceInfo Edit rule configuration Edits a service.
OssCheckResultList Query OSS detection results Retrieves the list of OSS detection results.
PublishAppConfig Publish app configurations Saves and publishes app configurations.
QueryAnswerSampleByPage Paged query of proxy answers Queries proxy answer samples by paging.
QueryCallback Query message notification Queries a single callback configuration.
QueryCallbackByPage Query message notifications by paging Queries the list of message notifications by paging.
QueryLabelConfig Query label configurations Queries label configurations.
RecoverAppConfigHistory Revert app to historical version Reverts an app to a historical version.
StopOnlineTest Abort an online detection task Aborts an online detection task.
UpdateAiAppScanStatus Update agent detection status Updates the scan status of AI applications.
UpdateBackupConfig Edit evidence transfer configuration Updates the evidence transfer configuration.
UpdateEventStatus Handle risk events Updates the status of risk events.
UpdateImageLib Edit an image library Edits an image library.
UpdateImageLibFreeInspection Edit image library inspection-exempt configuration Edits the inspection-exempt configuration of an image library.
UpdateKeywordLib Edit a keyword library Edits a keyword library.
UpdateMetaLog Update log delivery information Updates Meta log information.
UpdateOssCheckResultsBatchFeedback Batch update detection result feedback Updates OSS detection result feedback in batches.
UpdateOssCheckResultsFeedBack Update OSS detection result feedback Updates the feedback for OSS detection results.
UpdateOssCheckResultsFreeze Update OSS scan result freezing Freezes OSS scan results in batches.
UpdateOssCheckResultsUnfreeze Unfreeze OSS detection results Unfreezes OSS detection results in batches.
UpdateScanResultFeedback Submit detection result feedback Submits feedback on detection results.
UpdateServiceConfig Update service configuration Updates a service.
Previous：API Reference (Configuration Management)Next：Endpoints