API overview

Updated at:

API standards and multilingual preset SDKs

The OpenAPI of this product (xtee/2021-09-10) 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

RecallRuleAudit Withdraw a review Withdraws a review.
DescribeAuditDetails Approval details Retrieves approval details.
ModifyRulePriority Modify policy priority Modifies the priority of a policy.
UpdateRule Update a policy Updates a policy.
UpdateAudit Policy approval Processes an approval request.
DeleteRule Delete a rule Deletes a policy version.
CreateRule Create a rule Creates a policy and version.
ModifyRuleStatus Modify policy status Changes the approval status of a policy version.
DescribeUserInfo Retrieve current logged-on user information Retrieves the information about the current logged-on user.
DescribeRulePageList List policies by page Queries a list of policies.
DescribeAuditPageList Audit list Displays and queries the audit list.
DescribeRuleVersionList List policy versions Queries the list of policy versions.
DescribeAuditConfig Approval configuration Configures the approval switch.
UpdateRuleBase Update basic policy information Updates the basic information of a policy.
DescribeRuleDetailByRuleId Query Policy Details Query policy/version details.
ExpressionTest Test a custom variable Tests a custom variable.
DescribeAllRootVariable Display all root variables during custom expression testing Displays all root variables during custom expression testing.
DescribeDetailStart Retrieve detailed statistics Retrieves detailed statistics.
DescribeServiceAppKey Dropdown values for service and appKey Retrieves the dropdown values for ServiceAppkey.
DescribeBasicStart Basic statistics Queries basic statistics.
DeleteQueryVariable Delete a custom query variable Deletes a custom query variable.
DescribeQueryVariableDetail Query custom query variable details Queries the details of a custom query variable.
DescribeAllDataSource List data sources Lists data sources.
DescribeDataSourceFields Retrieve data source fields by data source code Retrieves all fields of a data source.
SwitchQueryVariable Query variable enabling or disabling status Queries the enabling or disabling status of a variable.
DescribeQueryVariablePageList Query custom query variables by page Queries a list of custom query variables.
UpdateQueryVariable Edit custom query variable Modifies a custom query variable.
DescribeDataSourcePageList Query external data sources Queries a list of data sources.
CreateQueryVariable Create a custom query variable Creates a custom query variable.
DescribeDataSourceDataDownloadUrl Download a file by file name Retrieves the download URL for data source data.
CreateDataSource Create a query variable data source Creates a data source.
UpdateDataSource Modify external data source Modifies a data source.
DescribeOssPolicy Query OSS upload credentials Retrieves the OSS policy.
DeleteDataSource Delete a data source Deletes a data source.
CreateAnalysisConditionFavorite Save query condition Creates a query condition.
CreateAnalysisExportTask Create export task Creates an export task.
DeleteAnalysisConditionFavorite Delete a favorite query condition Deletes a query condition.
DescribeAdvanceSearchPageList Advanced query for event analysis Performs an advanced query for event analysis.
DescribeAnalysisColumnFieldList Query all fields for event analysis Displays all fields.
DescribeAnalysisColumnList Query custom columns for event analysis Queries custom columns.
DescribeAnalysisConditionFavoriteList Query Condition Favorite List Queries the condition favorite list.
DescribeAnalysisExportTaskDownloadUrl Download query results Download query results.
DescribeBasicSearchPageList Event analysis basic query Performs a basic query.
DescribeEventDetailByRequestId Query event details by request ID Queries event details by request ID.
DescribeEventVariableList List variables under an event Queries event variables.
DescribeRuleListByEventCodesList Query policy list by event code Queries a list of policies.
SaveAnalysisColumn Save custom columns Saves custom columns.
UpdateAnalysisConditionFavorite Modify a query condition Modifies a query condition.
DescribeAdvanceSearchLeftVariableList Retrieve left-hand variables for advanced query Retrieves left-hand variables for advanced queries.
DescribeOperatorListByType Query operator mapping list by scenario Queries the list of operator mappings.
DescribeAuthRulePageList Query policy list Queries a list of policies.
DescribeAuthSceneList Scenario drop-down list Queries the list of scenarios.
DescribeAuthScenePageList Query scenario list Queries the list of scenarios.
QueryAuthRuleDetailByRuleId Query whitebox implementation policy details Queries the details of a whitebox implementation policy.
UpdateAuthRule Modify an authorization policy Modifies an authorization policy.
DescribeHitRuleTrend Query policy hit trends Queries the policy hit trends.
DescribeDecisionResultTrend Query decision result fluctuation trend Queries the fluctuation trend of decision results.
DescribeHighRiskPieChart Risk map high-risk pie chart and map Retrieves the risk map overview chart (pie chart).
DescribeDecisionResultFluctuation Detect decision result fluctuations Detects fluctuations in decision results.
DescribeHitRuleFluctuation Detect policy hit fluctuations Detects fluctuations in policy hits.
DescribeTagsFluctuation Detect label fluctuations Detects label fluctuations.
DescribeResultCount Drill-down analysis list Performs drill-down analysis.
DescribeRequestPeakReport Request rate (QPS) Request Rate (QPS).
DescribeEventTotalCountReport Call event count Call event count
DescribeEventResultBarChart Risk Dashboard Risk Dashboard
DescribeEventResultList Query event overview list Queries the event overview list.
DescribeRuleBarChart Query policy overview list Queries the policy overview list.
DescribeAvgExecuteCostReport Average execution duration Average execution duration.
DescribeTagsTrend Tag fluctuation trend Queries the trend of tag hits.
DescribeRiskLineChart Risk Map Line Chart Risk Map Overview Chart (Line Chart)
DescribeTagsBarChart Query tag overview list Queries the tag overview list.
DeleteByPassShuntEvent Delete a bypass event Deletes a bypass event.
DescribeByPassShuntEvent View a bypass event Queries a bypass event.
DescribeHitRuleList Top 20 main event/bypass/automatic request distribution policies by hits Queries the top 20 policies by hits for main events, bypass, and automatic request distribution.
DescribeScoreSectionNumLineChart Bypass/diversion - score range quantity analysis Analyzes the quantity distribution across score ranges.
DescribeScoreSectionPieChart Score range distribution pie chart for main events, bypass events, and diversion events Queries the score range distribution of main events, bypass events, and diversion events.
DescribeScoreSectionRatioLineChart Bypass/Shunt - Score Range Proportion Analysis Score Range Proportion Analysis
DescribeTagsNumLineChart Bypass/diversion - label hit count analysis Analyzes the number of label hits.
DescribeTagsRatioLineChart Bypass/Diversion - tag hit ratio analysis Analyzes the tag hit ratio distribution.
SaveByPassOrShuntEvent Configure bypass/diversion The bypass/diversion configuration.
StartOrStopByPassShuntEvent Start or stop a bypass event Starts or stops a bypass event.
SwitchToOnline Switch a bypass event to online Switches an event to online with one click.
UpdateByPassShuntEvent Edit a bypass event Edits a bypass event.
UpdateSampleBatch Batch modify samples Modifies samples in batches.
CreateSample Add a data sample Adds a data sample.
DescribeOssAuthStatus Check whether OSS is authorized Checks whether OSS is authorized.
DescribeApi Get API details Retrieves the details of an API.
DescribeGroupPage Query community list Queries the list of communities.
DescribeSampleList Query Sample List Queries the sample list.
ModifyAppKey Update Memo Update memo.
DescribeRegions Query the list of regions supported by API gateway Queries the list of regions supported by API Gateway.
DescribeExcuteNum Self-Service Invocation List Self-service invocation list.
DescribeGroupConditionList Query community list filter conditions Queries the filter conditions for the community list.
DescribeApis Retrieve API list including purchased and custom APIs Retrieves the API list, including purchased and custom APIs.
DeleteSampleBatch Delete samples in batches Deletes samples in batches.
DescribeSafConsole Query SAF permissions Queries SAF permissions.
DescribeOssToken Retrieve file upload credential Retrieves the upload credential for a file.
DescribeApiVariable Query variable details Query variable details.
DescribeSampleInfo Query data sample details Queries the details of a data sample.
DescribeSampleTagList Retrieve label list Retrieves the list of labels.
DescribeMarkPage Query tagging list Queries the tagging list.
DescribeGroupTrend Query recent trends of risky communities Queries recent trends of risky communities.
DescribeGroupStatisticsByToday Query risk communities discovered on the current day Queries the risk communities discovered on the current day.
DescribeGroupAccountPage Community account list Queries the list of community accounts.
DescribeApiGroups Retrieve API groups including purchased and custom groups Retrieves API groups, including purchased and custom groups.
DescribeTemplateDownload Download a template Downloads a template.
DescribeExistScene Check whether a scenario exists Checks whether a scenario exists.
DescribeSampleDataList Paging query of sample list Performs a paging query on the sample list.
ImportTemplateEvent Import template events Imports template events.
DescribeRecommendVariablesVelocity Query metric information of a variable Queries the metric information of a variable.
CreateSampleData Create sample data Creates sample data.
StopSimulationTask Stop a task Stops a task.
DescribeSimulationPreditInfo Estimate call information Estimates call information.
DescribeSampleSceneList Query scenario list Queries the list of scenarios.
DeleteSampleData Delete sample data Deletes sample data.
DescribeSampleDemoDownloadUrl Query data sample authorization Queries the authorization of a data sample.
DescribeTaskLogList Query task logs Queries the task logs.
DescribeSampleDownloadUrl Query data sample download authorization information Queries the authorization information for downloading a data sample.
DescribeRecommendSceneVariables Query variable list under a data sample and scenario Queries the list of variables under a data sample and scenario.
DescribeSupportRuleList Query policies that support simulation Queries the list of policies that support simulation.
StartSimulationTask Start executing a task Starts executing a task.
DescribeSimulationTaskList Query task list Queries the task list.
DescribeEventTaskHistory Query policy download list Queries the policy download list.
CreateRecommendEventRule Create a recommended event policy Creates a recommended event policy.
DescribeRecommendVelocities Query supported metrics Queries the list of supported metrics.
CreateSimulationTask Create task Creates a task.
DescribeRecommendTaskDetail Query variable recommendation details Queries the details of variable recommendations.
DescribeOperationLogPageList Query operation logs Queries the list of events by event name.
DescribeTemplatePageList Query event list by event name Queries a list of events by event name.
CreateRecommendTask Create a recommendation task Creates a recommendation task.
DescribeSimulationTaskCount Query task record count Queries the number of task records.
DescribeRecommendTaskPageList Query variable recommendation list Queries the variable recommendation list.
DescribeEventLogDetail Query event history details Queries the details of an event history.
DescribeMenuPermission Query whether a permission is granted Queries whether the current user has the specified permission.
ModifyEventStatus Modify event status Modifies the status of an event.
OpenConsoleSls Activate a service Activates a service.
DescribeLoanTaskList Retrieve in-loan monitoring task list Retrieves the list of in-loan monitoring tasks.
DescribeSelectItem Query task ID list Queries the list of task IDs.
DescribeSlsUrlConfig Retrieve project configuration Retrieves the project configuration.
DescribeMonitorTaskLimit Query task limits Queries the limits of tasks.
DescribeSDKDownloadList Query SDK download list Queries the list of SDK downloads.
CheckFieldLimit Check whether the number of fields exceeds the limit Checks whether the number of fields exceeds the specified limit.
DescribeLoanExecList Query the list of monitoring objects Queries the list of monitoring objects.
DescribeSafTagList Retrieve risk label list Retrieves the list of risk labels.
DescribeAppKeyPage Query appKey list Queries the list of appKeys.
DescribeEventUploadPolicy Batch import policies Imports policies in batches.
DescribeSafStartSteps Query access step details Queries access configurations.
ModifyEvent Edit an event Edits an event.
DescribeApiNameList Retrieve API service names Retrieves API service names.
DescribeAuthStatus Check whether authorization is granted Checks whether authorization is granted.
DescribeSampleUploadPolicy Query sample upload authorization information Queries the authorization information for sample uploads.
DescribeSafOrder Query order information Queries order information.
DescribeApiLimit Query limit information for creating API tasks Queries the limit information for creating API tasks.
DescribeEventLogPage Query event history list Queries the event history list.
RemoveEvent Delete an event Deletes an event.
DescribeDownloadUrl Download Downloads a file.
DescribeRuleHit DescribeRuleHit Queries the details of policy rule hits.
DescribeUsedService Query the list of services used by the user Queries the list of services used by the user.
DescribeAuthEventNameList Query event names for the current user Queries the list of event names for the current user.
CreateAppKey CreateAppKey Create an AppKey.
DescribeRequestHit Query request hit details Queries the hit details of a request.
DescribeAllEventNameAndCode Event name code mapping list Queries the event list.
CreateEvent Create an event Creates an event.
DescribeSafDeOrder Query saf_de order information Queries saf_de orders.
DescribeRuleSnapshot DescribeRuleSnapshot Query historical snapshots based on ruleId and version.
DescribeServiceList Retrieve service list Retrieves the list of services.
DescribePocTaskList Retrieve POC task list Retrieves the list of POC tasks.
DescribeSafStartConfig Query access configuration Queries the access configuration.
DescribeEventCount Query total number of events Queries the total number of events.
DescribeEventPageList Query events by paging Queries events by paging.
DescribeFieldById Query field details Retrieves field details.
SwitchExpressionVariable Modify custom variable status Enables or disables a custom variable.
DescribeFieldPage Query paginated field list Queries a paginated list of fields.
CheckUsageVariable Check variable references Checks variable references.
DeleteNameList Delete a list Deletes a list.
DescribeExistName Check whether a field name is duplicate Checks whether a field name is duplicate based on the user unit.
DescribeCustVariablePage List cumulative variables by page Queries the list of custom cumulative variables.
BindVariable Variable binding Performs a variable binding operation.
DeleteField Delete a field Deletes a field.
DescribeNameListLimit Query list quota limit Queries the quota limit for lists.
OperateFavoriteVariable Manage variable favorites Manages favorites.
ModifyField Modify a field Modifies a field.
DescribeEventVariableTemplateBind Query event pattern template Queries an event pattern template.
DeleteNameListData Delete list data Deletes list variable data.
CreateExpressionVariable Create a custom variable Creates a custom variable.
DescribeVariableList Query variable list Queries the details of variables.
DescribeHasRuleNameByEventCode Query whether a policy name exists under an event name Queries whether a policy name exists under a specified event name.
DescribeFieldList Field list Queries the list of fields.
SwitchField Enable or disable a field Toggles a field on or off.
SwitchVariable Enable or Disable Cumulative Variable Enables or disables a cumulative variable.
CheckCustVariableLimit Check whether the number of cumulative variables exceeds the limit Checks whether the number of cumulative variables exceeds the limit.
CheckExpressionVariableLimit Check whether creating a custom variable exceeds the upper limit Checks whether creating a variable exceeds the upper limit.
CreateCustVariable Create a cumulative variable Creates a cumulative variable.
CreateField Create a field Creates a field.
DeleteCustVariable Delete a cumulative variable Deletes a cumulative variable.
DeleteExpressionVariable Delete a custom variable Deletes a custom variable.
DescribeCustVariableConfigList Query custom cumulative variable configurations Queries the type configurations of custom cumulative variables.
DescribeCustVariableDetail Query cumulative variable details Queries the details of a cumulative variable.
DescribeEventBaseInfoByEventCode Query event details Queries event details.
DescribeEventsVariableList Query event variables Queries event variables.
DescribeExpressionVariableDetail Query custom variable details Queries the details of a custom variable.
DescribeExpressionVariableFunctionList Query function list Queries the function list.
DescribeExpressionVariablePage Paging query of custom variables Performs a paging query of custom variables.
DescribeNameList Query name list by page Queries a name list by page.
DescribeOperatorList Query operator mapping list Queries the operator mapping list by customer ID.
DescribeParamByEventCodes Query event property list Queries the list of event properties.
DescribeRuleCountByUserId Query the number of policies by user ID Queries the number of policies by user ID.
DescribeVariableBindDetail Query variable binding information Queries variable binding information.
DescribeVariableDetail Query variable details Queries the details of a variable.
DescribeVariableFee Query variable billing information Queries the billing information of variables.
DescribeVariableMarketList List variable definitions Queries variable definitions.
DescribeVariableSceneList Query configuration information Queries configuration information.
ImportNameList Create or import a list Creates or imports a list.
ModifyCustVariable Edit a cumulative variable Edits a cumulative variable.
ModifyExpressionVariable Edit a custom variable Edits a custom variable.
CreatePocEv Create POC Creates a POC.
DescribeListPoc POC task list Queries the list of tasks.
DescribeTagList Query label list Queries the label list.
FileUpload Upload a file Uploads a file.
PermissionCheck Perform precondition check Performs a precondition check.
SampleFileDownload SampleFileDownload Download template.
TaskNameByUserId Check whether a task name is duplicate Checks whether a task name is duplicate.
DescribeNameListVariablePageList Query named lists Queries a list of named lists.
DescribeNameListPageList Query lists by page Queries the content of a list.
DescribeNameListTypeList Query name list types Queries the list of name list types.
DescribeNameListDownloadUrl Download list content Downloads the content of a list.
DescribePrivateStack Check whether the stack private domain mode is enabled for a user Checks whether the Stack private domain mode is enabled.
DescribeSceneEventPageList Query scenario-based risk control event list Queries the list of scenario-based risk control events.
DescribeSceneAllEventNameCodeList Query scenario-based risk control event dropdown list Queries the dropdown list of scenario-based risk control events.
DescribeSceneRulePageList List scenario-based risk control event policies Queries the list of scenario-based risk control event policies.

其他

API

Title

Description

CreateSampleApi Upload samples through API Creates a sample batch for a single API at the user level.
DescribeOperatorListByScene Query operator mapping list by scene Queries the operator mapping list.
DescribeEventVariableTemplateList Query event pattern template Queries an event pattern template.
DescribeInputFeildCountByEventCode Query total number of events Queries the total number of events.
AddSampleDataByCsv Add Sample Data via CSV Add Sample Data via CSV
AddSampleDataByText Add Sample Data via TEXT Add list data through a text box for samples
BatchDeleteSampleData Batch Delete Sample List Data Batch Delete Sample List Data
CancelSubTask Cancel job Create a task group
CheckCopyRuleVariable Check if Copied Policy Replication Lineage Check
CheckSampleName Validate sample name uniqueness Validate sample name uniqueness
CheckTaskGroupName Validate the uniqueness of the task group name Validate the uniqueness of the task group name
CompareCopyRuleVariable Policy Replication Comparison Policy Comparison
CompareRule Policy Version Comparison Policy Comparison.
CreateForeignPocSample Create Sample Library Create a sample record for the customer.
CreateModel Create Model Submit Task
CreatePocSample Create Sample Create a sample record
CreateSampleBatch Create Sample Batch Create Sample Batch
CreateTaskGroup Create task group Cancel subtask
DeepCopyRule Policy Replication Policy Replication
DeleteEventField Delete Event Field Delete Event Field
DeleteSample Delete sample Delete sample
DeleteSampleBatchMeta Sample Deletion Sample Deletion
DeleteSelfBindVariable Delete Custom System Variable Delete Custom System Variable
DescribeExpressionVariableVersionDetail Query Custom Variable Version Details Custom Variable Version Details.
DescribeInitDig POC Popup Prompt Information Initialization Popup Information
DescribeListModel Model Task List Display of Model List
DescribeModelDetailsById View Details View Result
DescribeModelOssPolicy Model OSS Information Get File Upload Credentials
DescribeOperationLogMonitoring Query Operation Log Monitoring Statistics Query Operation Log Monitoring Statistics
DescribePocOssToken Retrieve file upload credential Retrieves the file upload credential.
DescribeRiskTagsLineChart Tag Hit Rate Tag Hit Dimension Tag Hit Rate Tag Hit Dimension
DescribeSampleBatchOssPolicy Get File Upload Credentials Get File Upload Credentials
DescribeSampleDataByBatchUUidPage Sample List Sample List
DescribeSampleDataPage Sample List Sample List
DescribeSamplebatchPage Sample Batch List Sample Batch List
DescribeScoreList Score Distribution Score Distribution
DescribeServiceCodeName All Services ServiceCodeName Information
DescribeTagsList Retrieve label list Retrieves the list of labels.
DescribeTaskList Query task list Queries the task list.
DescribeTemplateCount Query total number of events Queries the total number of events.
DescribeVariableVersionDetail Cumulative Variable Version Details Cumulative Variable Version Details.
DescribeVersionPageList Variable Version List Query Variable Version List Query
DownloadSampleFile Download sample file Download sample file
DownloadSmapleBatch Sample List Data Download Sample List Data Download
DownloadSubTaskResult Download subtask result Download subtask result
GetSampleDetail Obtain sample details Create a sample record
GetSubTaskResult Obtain subtask result View subtask results
ImportField Batch Import Fields Batch Import
ListSample Sample List Sample List Query
ListTaskGroup Task group list Query task group list
ListVariableDefine Query Variable Definition Query Variable Definition
MergeDownload Merge Download Merge Download
ModelDelete Delete Model Delete
ModelFileUpload File Upload Validation File Upload
ModelIsUsing Enable/Disable Enable, Disable
ModelNameIsDuplication Is Model Name Duplicated Is Model Name Duplicated
ModelSampleDownload Template Download Template Download
PocCreateTask Create POC Task createTask
PocGetDownloadUrl Get Download URL PocGetDownloadUrl
PocGetToken Request Token getToken
PocSendData Batch Upload sendData
SearchSample Sample query Sample Search
UploadFileCheck Sample Inspection Sample Inspection
UploadForeignSampleFile Upload sample file Upload and validate the sample file for the customer.
UploadSampleFile Upload file Upload and validate the sample file