Enabling Anti-DDoS
Function
This API is used to enable Anti-DDoS.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/antiddos/{floating_ip_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
floating_ip_id |
Yes |
String |
ID corresponding to the EIP of a user. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
ip |
No |
String |
EIP of a user. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Content-Type |
Yes |
String |
Content-Type request header. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
app_type_id |
Yes |
Long |
Application type ID. The value is fixed to 0. |
|
cleaning_access_pos_id |
Yes |
Long |
Position ID of access limit during cleaning. The options are as follows: 1: 10 Mbit/s; 2: 30 Mbit/s; 3: 50 Mbit/s; 4: 70 Mbit/s; 5: 100 Mbit/s; 6: 150 Mbit/s; 7: 200 Mbit/s; 8: 250 Mbit/s; 9: 300 Mbit/s; 10: 500 Mbit/s; 11: 800 Mbit/s;88: 1,000 Mbit/s; 99: default protection |
|
enable_L7 |
Yes |
Boolean |
Whether to enable layer-7 protection. The value is fixed to false. |
|
http_request_pos_id |
Yes |
Long |
Segment ID of the HTTP request counts. The value is fixed to 1. |
|
traffic_pos_id |
Yes |
Long |
Position ID of traffic. The options are as follows: 1: 10 Mbit/s; 2: 30 Mbit/s; 3: 50 Mbit/s; 4: 70 Mbit/s; 5: 100 Mbit/s; 6: 150 Mbit/s; 7: 200 Mbit/s; 8: 250 Mbit/s; 9: 300 Mbit/s; 10: 500 Mbit/s; 11: 800 Mbit/s;88: 1,000 Mbit/s; 99: default protection |
|
antiddos_config_id |
No |
String |
Protection level ID. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Internal error code. |
|
error_msg |
String |
Internal error description. |
|
task_id |
String |
ID of a task. This ID can be used to query the status of the task. This field is reserved for future task audit extension and is not required currently. |
Example Requests
Enable the Anti-DDoS policy for a specified EIP. Set the position ID of access limit during cleaning to 8, and set the position ID of traffic to 1.
POST https://{endpoint}/v1/{project_id}/antiddos/{floating_ip_id}
{
"app_type_id" : 0,
"cleaning_access_pos_id" : 8,
"enable_L7" : false,
"http_request_pos_id" : 1,
"traffic_pos_id" : 1,
"antiddos_config_name" : "test",
"antiddos_config_id" : "1234567890"
}
Example Responses
Status code: 200
Request succeeded.
{
"error_code" : "10000000",
"error_msg" : "The task has been received and is being handled",
"task_id" : "59385d2a-6266-4d3a-9122-a228c530f557"
}
SDK Sample Code
The SDK sample code is as follows.
Enable the Anti-DDoS policy for a specified EIP. Set the position ID of access limit during cleaning to 8, and set the position ID of traffic to 1.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.antiddos.v1.region.AntiDDoSRegion; import com.huaweicloud.sdk.antiddos.v1.*; import com.huaweicloud.sdk.antiddos.v1.model.*; public class EnableDefensePolicySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AntiDDoSClient client = AntiDDoSClient.newBuilder() .withCredential(auth) .withRegion(AntiDDoSRegion.valueOf("<YOUR REGION>")) .build(); EnableDefensePolicyRequest request = new EnableDefensePolicyRequest(); request.withFloatingIpId("{floating_ip_id}"); OpenAntiDDosServiceRequestBody body = new OpenAntiDDosServiceRequestBody(); body.withTrafficPosId(1L); body.withHttpRequestPosId(1L); body.withEnableL7(false); body.withCleaningAccessPosId(8L); body.withAppTypeId(OpenAntiDDosServiceRequestBody.AppTypeIdEnum.NUMBER_0); request.withBody(body); try { EnableDefensePolicyResponse response = client.enableDefensePolicy(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Enable the Anti-DDoS policy for a specified EIP. Set the position ID of access limit during cleaning to 8, and set the position ID of traffic to 1.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkantiddos.v1.region.antiddos_region import AntiDDoSRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkantiddos.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AntiDDoSClient.new_builder() \ .with_credentials(credentials) \ .with_region(AntiDDoSRegion.value_of("<YOUR REGION>")) \ .build() try: request = EnableDefensePolicyRequest() request.floating_ip_id = "{floating_ip_id}" request.body = OpenAntiDDosServiceRequestBody( traffic_pos_id=1, http_request_pos_id=1, enable_l7=False, cleaning_access_pos_id=8, app_type_id=0 ) response = client.enable_defense_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Enable the Anti-DDoS policy for a specified EIP. Set the position ID of access limit during cleaning to 8, and set the position ID of traffic to 1.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" antiddos "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := antiddos.NewAntiDDoSClient( antiddos.AntiDDoSClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.EnableDefensePolicyRequest{} request.FloatingIpId = "{floating_ip_id}" request.Body = &model.OpenAntiDDosServiceRequestBody{ TrafficPosId: int64(1), HttpRequestPosId: int64(1), EnableL7: false, CleaningAccessPosId: int64(8), AppTypeId: model.GetOpenAntiDDosServiceRequestBodyAppTypeIdEnum().E_0, } response, err := client.EnableDefensePolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot