This page covers the four setup decisions you need to make before your first WAF API call: which API version to use, which endpoint to target, which identity type to authenticate with, and which calling method to use.
For a general introduction to calling Alibaba Cloud API operations, see Overview.
API version
| Version | Status |
|---|---|
| 2021-10-01 | Recommended |
Endpoints
For the full list of endpoints, see Endpoints.
Authentication
WAF supports three identity types for API authentication:
| Identity | Supported |
|---|---|
| Alibaba Cloud account | Yes |
| RAM user (recommended) | Yes |
| RAM role (recommended) | Yes |
Use a Resource Access Management (RAM) user or RAM role rather than your Alibaba Cloud account. RAM identities let you grant only the permissions your application needs, which reduces the risk of accidental or unauthorized changes. Before making API calls with a RAM user or RAM role, grant it the required WAF permissions.
API style
WAF API operations use the remote procedure call (RPC) style. For details on Alibaba Cloud API styles, see API styles.
Calling methods
| Method | Supported | Reference |
|---|---|---|
| Alibaba Cloud SDKs (recommended) | Yes | WAF SDK and Alibaba Cloud SDKs |
| Alibaba Cloud CLI | No | — |
| Resource Orchestration Service (ROS) | Partially supported | ROS |
| Terraform | Partially supported | Terraform |
| Custom encapsulation | Yes | Custom encapsulation |
Alibaba Cloud SDKs are the recommended calling method.