API overview

Updated at:

API standards and multilingual preset SDKs

The OpenAPI of this product (safconsole/2025-05-21) 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

ApplyBastionAccount Apply for a bastion host account Applies for a bastion host account.
AssociatePocTask Associate a POC backtracking task Associates a POC backtracking task.
CompleteModelingProject Complete a project Completes a project.
CreateCustomerModuleMetaInfo Save feature information Saves feature information.
CreateModelingProject Create a security modeling project Creates a security modeling project.
DeployModelFile Deploy a model generated by security modeling Deploys a model generated by security modeling.
DescribeCustomerModuleMetaInfo Query model feature information Queries model feature information.
DescribeCustomerModuleOutputInfo Query model output information Queries model output information.
DescribeFeatureOption Retrieve feature dropdown options by feature template Retrieves the dropdown options for features based on the selected feature template.
DescribeFeatureTemplateList Query feature templates Queries feature templates.
DescribeFileDownloadUrl Get file download URL Retrieves the download URL of a file.
DescribeModelFeature Automatic feature rendering information Retrieves automatic feature rendering information.
DescribeModelOssToken Obtain OSS upload credential Obtains an OSS upload credential.
DescribeModelingProjectDetail Query security modeling project details Queries the details of a security modeling project.
DescribeModelingProjectList List security environment modeling projects Queries the list of security environment modeling projects.
DescribeModuleServiceExist Check whether a service exists Checks whether a service exists for a specified query.
DescribeModuleStatus Query status Queries the status of a customer model.
DescribePocTaskList Query POC backtracking list Queries the POC backtracking list.
DescribeSafRmmpOrder Query order permissions Queries order permissions.
DescribeServiceAndScene Query the scene and service corresponding to a model Queries the scene and service corresponding to a model.
DescribeUserModelList Query user model list Queries the list of user models.
DuplicateModel Copy a model Copies a model.
EditModel Return a model to edit mode Returns a model to edit mode.
GetBastionHostCertification Retrieve initial logon password Retrieves the initial logon password.
IterateModel Iterate Model Iterate Model
OfflineModel Offline a model Takes a model offline.
OnlineModel Bring a model online Brings a model online.
ParseExpressionParameters Test expression parsing Tests expression parsing.
PrepublishModel Submit test environment Submits a test environment.
RequestModelFileSync Apply to synchronize model files Applies to synchronize model files.
RollbackModel Rollback Performs a rollback.
TestModel Submit model test Submits a model test.
TestPreModel Verify test environment Verifies the test environment.