Integration overview

Updated at:

In addition to its web console, Data Security Center offers multiple integration methods, such as OpenAPI Explorer, Alibaba Cloud SDK, and Terraform, to streamline your application development and deployment.

OpenAPI overview

Alibaba Cloud provides the OpenAPI portal to help developers use cloud product OpenAPI. This portal is a comprehensive tool that integrates features such as intelligent OpenAPI search, documentation, online debugging, SDK acquisition, code samples, call error diagnosis, and call statistics. You can use the OpenAPI portal to call the OpenAPI of various Alibaba Cloud products and view request and response results. The portal also automatically generates SDK code examples to accelerate your development. For more information, see What is OpenAPI?

Version

You can debug the API list for the 2019-01-03 version online. 2019-01-03 is an API version identifier, not a date. The portal displays the latest publicly available API data and is continuously updated, not frozen since 2019-01-03. To learn how to check the API version, see View API versions.

Version

Description

2019-01-03

Supports features provided by Data Security Center, such as sensitive data detection, data desensitization, and risk event detection.

Online debugging

Data Security Center supports API debugging in the Alibaba Cloud OpenAPI portal. Before you begin, familiarize yourself with the API version, endpoint details, and API parameters.

To debug an API, go to: https://api.aliyun.com/api/Sddp/2019-01-03

On the OpenAPI Explorer page, the left pane contains the API list, categorized by functions such as service-linked roles, authorization, and detection configurations. In the center pane, you can select a service endpoint, such as China (Zhangjiakou), enter API parameters, and then click Initiate Call to run the debug request. The right pane displays API documentation, call results, and SDK and CLI examples.

Endpoints

To minimize latency, select the endpoint in your resource region. For example, in the China (Zhangjiakou) region, the public endpoint for Data Security Center is sddp.cn-zhangjiakou.aliyuncs.com, and the VPC endpoint is sddp-vpc.cn-zhangjiakou.aliyuncs.com.

  • Public endpoints are accessible globally.

  • VPC endpoints are accessible only from within the corresponding Alibaba Cloud region and VPC network. The advantages of using a VPC endpoint include:

    • High security: VPC endpoints can be accessed only from within a VPC, providing enhanced security and privacy.

    • Faster response times: Because they operate within the VPC internal network, VPC endpoints typically offer faster response times than public endpoints and avoid public network latency or bandwidth limitations.

    • Lower costs: VPC endpoints use internal network communication.

For more information, see Service Endpoints.

Supported identities

After you log on to the OpenAPI portal with your Alibaba Cloud account, OpenAPI Explorer uses your account to make API calls by default. Because an Alibaba Cloud account has full access to all APIs, it carries a high security risk. We strongly recommend creating and using a RAM user for API access and daily operations. Before making API calls, grant the RAM user the necessary permissions based on your business needs. For more information, see Grant DSC permissions to a RAM user.

Identity

Supported

Alibaba Cloud account

Yes

RAM user (Recommended)

Yes

RAM role (Recommended)

Yes

More information

Integration methods

Note

We recommend using an Alibaba Cloud SDK for OpenAPI calls, as it is the easiest and most supported integration method.

Method

Supported

Alibaba Cloud SDK

Yes

Alibaba Cloud CLI

No

Resource Orchestration Service (ROS)

No

Terraform

Partially

Custom-encapsulated API calls

Yes

Alibaba Cloud SDK

  • Alibaba Cloud provides SDKs for multiple programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. Simply integrate the SDK and call the OpenAPI methods it exposes. The SDKs handle low-level details such as signature calculation, timeout settings, and retry mechanisms. They also provide request and response objects, which simplifies development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.

  • You can call OpenAPI by using the Data Security Center SDK. For information about supported languages and how to install dependencies, see Data Security Center SDK.

Alibaba Cloud CLI

  • Alibaba Cloud Command Line Interface (CLI) allows you to interact with Alibaba Cloud services and manage your cloud resources from a command-line terminal by using the aliyun command. For more information about the Alibaba Cloud CLI, see What is Alibaba Cloud CLI?.

  • Data Security Center does not currently support the Alibaba Cloud CLI.

Resource Orchestration Service (ROS)

  • Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies cloud resource management. You can create templates that define the required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS orchestration engine then automatically creates and configures all resources based on the template to enable automated deployment and O&M. For more information, see What is Resource Orchestration Service?.

  • Data Security Center does not currently support ROS.

Terraform

  • Terraform is an open-source tool for safely and efficiently previewing, provisioning, and managing cloud infrastructure and resources. It works similarly to Alibaba Cloud ROS by converting templates into internal data structures and then making OpenAPI calls. For more information, see Alibaba Cloud Terraform overview.

  • You can use Terraform to manage Data Security Center resources. The following resource types are supported:

    Type

    Resource/data source

    Description

    Resources

    alicloud_sddp_config

    Modifies the general configuration for anomaly detection alerts.

    alicloud_sddp_data_limit

    Creates authorization for data asset scanning.

    alicloud_sddp_instance

    instance

    alicloud_sddp_rule

    Creates custom rules for sensitive data detection.

    Data Sources

    alicloud_sddp_configs

    Provides Data Security Center configurations for the current Alibaba Cloud account.

    alicloud_sddp_data_limits

    Provides Data Security Center data limits for the current Alibaba Cloud account.

    alicloud_sddp_instances

    Provides Data Security Center instances for the current Alibaba Cloud account.

    alicloud_sddp_rules

    Provides Data Security Center rules for the current Alibaba Cloud account.

Custom-encapsulated API calls

If you use native HTTP calls, you must implement the signature algorithm and construct custom requests. For more information about the signature mechanism, see API overview and Request body and signature mechanism for V3.

Usage notes

  • The queries per second (QPS) limit for API calls is calculated per Alibaba Cloud account and varies by API. For details, see the QPS limit specified in the documentation for each API.

    Note

    All RAM users under an Alibaba Cloud account share the QPS quota of that account.

  • You can record the RequestID from the response or the error message from the SDK and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service troubleshooting.