Integration overview

Updated at:

Anti-DDoS Basic provides a console for visual operations and multiple methods for calling API operations, including OpenAPI Explorer, Alibaba Cloud SDKs, and Terraform. OpenAPI Explorer supports online debugging of API operations.

OpenAPI

Alibaba Cloud provides OpenAPI Explorer for developers to understand and use the API operations of various Alibaba Cloud services in a quick and efficient manner. OpenAPI Explorer integrates multiple features related to API operations, including intelligent search, documentation, online debugging, SDK download, sample code, error diagnostics, and call statistics. In OpenAPI Explorer, you can call API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?

Versions

Alibaba Cloud OpenAPI uses version numbers to manage API lists for major versions of its services. For example, Cloud Backup currently supports the API version 2017-05-18. The version number 2017-05-18 is an identifier for a specific API set and does not indicate a date. It represents the most current public API data for that version and does not mean the API has remained unchanged since 2017-05-18.

Version

Description

2017-05-18

We recommend that you use this version.

Online debugging

Anti-DDoS Basic supports features such as API debugging in OpenAPI Explorer. Before you call API operations, take note of the following information provided by Anti-DDoS Basic: versions, endpoints, API style, and integration methods.

To debug an API, go to https://api.aliyun.com/api/antiddos-public/2017-05-18. On the API debugging page, select the target API operation from the left-side navigation pane. In the central pane, select a Service Address, such as China (Hangzhou), configure the parameters, and then click Initiate Call.

Endpoints

Select the endpoint in your resources' region to minimize latency. For example, the public endpoint of Anti-DDoS Basic in the China (Zhangjiakou) region is antiddos-openapi.cn-zhangjiakou.aliyuncs.com, and the VPC endpoint is antiddos-openapi-vpc.cn-zhangjiakou.aliyuncs.com.

  • Public endpoints are accessible from anywhere in the world.

  • VPC endpoints are accessible only from within a VPC in the corresponding Alibaba Cloud region. VPC endpoints offer the following advantages:

    • High security: VPC endpoints can be accessed only from within a VPC. This provides higher security and privacy.

    • Fast response: VPC endpoints deliver faster responses than public endpoints because VPC endpoints enable data transmission over VPCs. In addition, problems such as network latency and bandwidth limitations can be prevented.

    • Low cost: VPC endpoints are accessed over an internal network.

For more information, see Endpoints.

Supported identities

By default, after you log on to OpenAPI Explorer by using your Alibaba Cloud account, the Alibaba Cloud account is used to perform online debugging. An Alibaba Cloud account has permissions on all API operations. If you use an Alibaba Cloud account to call API operations, security risks may arise. We strongly recommend that you call API operations or perform routine O&M by using a Resource Access Management (RAM) user. Before you call API operations by using a RAM user, grant the required permissions to the RAM user based on your business requirements.

Identity

Supported

Alibaba Cloud account

Yes

RAM user (recommended)

Yes

RAM role (recommended)

Yes

Further reading

Integration methods

Note

SDKs can be easily integrated with your applications and cover the widest range of operations. We recommend that you use SDKs to call API operations.

Calling method

Supported

Alibaba Cloud SDKs

Yes

Alibaba Cloud CLI

No

Resource Orchestration Service (ROS)

No

Terraform

Partially supported

Custom API encapsulation

Yes

Alibaba Cloud SDKs

  • Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, Node.js, TypeScript, PHP, and C++. You can integrate the SDKs with your applications to directly call API operations. SDKs encapsulate the signature logic, timeout mechanism, and retry mechanism and provide the request and response objects that facilitate development. For more information, see Alibaba Cloud SDKs.

  • You can use the Anti-DDoS Basic SDK to call APIs. For information about the programming languages supported by the Anti-DDoS Basic SDK and how to install dependencies, see Anti-DDoS Basic SDK.

Alibaba Cloud CLI

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

  • You cannot use Alibaba Cloud CLI to call the API operations of Anti-DDoS Basic.

ROS

  • ROS is an Alibaba Cloud service that simplifies the management of cloud computing resources. You can create a template to describe the required cloud computing resources such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, as well as the dependencies between the resources. The ROS engine automatically creates and configures all the resources based on the template to implement automated deployment and O&M. For more information, see What is ROS?

  • You cannot use ROS to call the API operations of Anti-DDoS Basic.

Terraform

  • Terraform is an open source tool that is used to preview, configure, and manage cloud infrastructure and resources in a secure and efficient manner. Terraform works in a similar manner to ROS. Terraform calls API operations by interpreting templates. For more information, see What is Terraform?

  • You can use Terraform to call the API operations of Anti-DDoS Basic. The following table describes the resource types that are supported.

    Type

    Item

    Description

    Resources

    alicloud_ddos_basic_defense_threshold

    Modifies the traffic scrubbing threshold.

    alicloud_ddos_basic_threshold

    Queries the DDoS protection threshold or traffic scrubbing threshold for a specified public IP asset.

Custom API encapsulation

To make native HTTP calls, you must construct custom requests and sign the requests. For more information about the signature mechanism, see List of operations by function and Request syntax and signature method V3.

Usage notes

  • The number of queries per second (QPS) that an Alibaba Cloud account can initiate varies based on the API operation. For more information, see the "QPS limits" section in the API reference of each operation.

    Note

    The RAM users of an Alibaba Cloud account share the QPS quota of the Alibaba Cloud account.

  • You can record the request ID returned from a call or the SDK error message and use OpenAPI Diagnostic to perform self-service diagnostics.