diff --git a/docs/antiddos/api-ref/ALL_META.TXT.json b/docs/antiddos/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..774fb8c7 --- /dev/null +++ b/docs/antiddos/api-ref/ALL_META.TXT.json @@ -0,0 +1,242 @@ +[ + { + "uri":"en-us_topic_0037386201.html", + "product_code":"antiddos", + "code":"1", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"antiddos_02_0040.html", + "product_code":"antiddos", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API", + "title":"API", + "githuburl":"" + }, + { + "uri":"antiddos_02_0016.html", + "product_code":"antiddos", + "code":"3", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Anti-DDoS APIs", + "title":"Anti-DDoS APIs", + "githuburl":"" + }, + { + "uri":"antiddos_02_0017.html", + "product_code":"antiddos", + "code":"4", + "des":"This API allows you to query optional Anti-DDoS defense policies. Based on your service, you can select a policy for Anti-DDoS traffic scrubbing.URI formatGET /v1/{projec", + "doc_type":"api", + "kw":"Querying Optional Anti-DDoS Defense Policies,Anti-DDoS APIs,API Reference", + "title":"Querying Optional Anti-DDoS Defense Policies", + "githuburl":"" + }, + { + "uri":"antiddos_02_0018.html", + "product_code":"antiddos", + "code":"5", + "des":"This asynchronous API allows you to enable the Anti-DDoS traffic scrubbing. Successfully invoking this API only means that the service node has received the enabling requ", + "doc_type":"api", + "kw":"Enabling Anti-DDoS,Anti-DDoS APIs,API Reference", + "title":"Enabling Anti-DDoS", + "githuburl":"" + }, + { + "uri":"antiddos_02_0019.html", + "product_code":"antiddos", + "code":"6", + "des":"This asynchronous API allows you to disable the Anti-DDoS traffic scrubbing. Successfully invoking this API only means that the service node has received the disabling re", + "doc_type":"api", + "kw":"Disabling Anti-DDoS,Anti-DDoS APIs,API Reference", + "title":"Disabling Anti-DDoS", + "githuburl":"" + }, + { + "uri":"antiddos_02_0020.html", + "product_code":"antiddos", + "code":"7", + "des":"This API enables you to query the Anti-DDoS defense policy of a specified EIP.URI formatGET /v1/{project_id}/antiddos/{floating_ip_id}GET /v1/{project_id}/antiddos/{float", + "doc_type":"api", + "kw":"Querying Configured Anti-DDoS Defense Policies,Anti-DDoS APIs,API Reference", + "title":"Querying Configured Anti-DDoS Defense Policies", + "githuburl":"" + }, + { + "uri":"antiddos_02_0021.html", + "product_code":"antiddos", + "code":"8", + "des":"This API enables you to update the Anti-DDoS defense policy of a specified EIP. Successfully invoking this API only means that the service node has received the update re", + "doc_type":"api", + "kw":"Updating Anti-DDoS Defense Policies,Anti-DDoS APIs,API Reference", + "title":"Updating Anti-DDoS Defense Policies", + "githuburl":"" + }, + { + "uri":"antiddos_02_0022.html", + "product_code":"antiddos", + "code":"9", + "des":"This API enables you to query the execution status of a specified Anti-DDoS configuration task.URI formatGET /v1/{project_id}/query_task_statusYou can use ? and & behind ", + "doc_type":"api", + "kw":"Querying Anti-DDoS Tasks,Anti-DDoS APIs,API Reference", + "title":"Querying Anti-DDoS Tasks", + "githuburl":"" + }, + { + "uri":"antiddos_02_0023.html", + "product_code":"antiddos", + "code":"10", + "des":"This API enables you to query the defense statuses of all EIPs, regardless whether an EIP has been bound to an Elastic Cloud Server (ECS) or not.URI formatGET /v1/{projec", + "doc_type":"api", + "kw":"Querying the List of Defense Statuses of EIPs,Anti-DDoS APIs,API Reference", + "title":"Querying the List of Defense Statuses of EIPs", + "githuburl":"" + }, + { + "uri":"antiddos_02_0024.html", + "product_code":"antiddos", + "code":"11", + "des":"This API allows you to query the defense status of a specified EIP.URI formatGET /v1/{project_id}/antiddos/{floating_ip_id}/statusGET /v1/{project_id}/antiddos/{floating_", + "doc_type":"api", + "kw":"Querying the Defense Status of a Specified EIP,Anti-DDoS APIs,API Reference", + "title":"Querying the Defense Status of a Specified EIP", + "githuburl":"" + }, + { + "uri":"antiddos_02_0025.html", + "product_code":"antiddos", + "code":"12", + "des":"This API allows you to query the traffic of a specified EIP in the last 24 hours. Traffic is detected in five-minute intervals.URI formatGET /v1/{project_id}/antiddos/{fl", + "doc_type":"api", + "kw":"Querying the Traffic of a Specified EIP,Anti-DDoS APIs,API Reference", + "title":"Querying the Traffic of a Specified EIP", + "githuburl":"" + }, + { + "uri":"antiddos_02_0026.html", + "product_code":"antiddos", + "code":"13", + "des":"This API allows you to query events of a specified EIP in the last 24 hours. Events include cleaning and blackhole events, and the query delay is within five minutes.URI ", + "doc_type":"api", + "kw":"Querying Events of a Specified EIP,Anti-DDoS APIs,API Reference", + "title":"Querying Events of a Specified EIP", + "githuburl":"" + }, + { + "uri":"antiddos_02_0027.html", + "product_code":"antiddos", + "code":"14", + "des":"This API allows you to query weekly defense statistics about all your IP addresses, including the number of intercepted DDoS attacks, number of attacks, and ranking by th", + "doc_type":"api", + "kw":"Querying Weekly Defense Statistics,Anti-DDoS APIs,API Reference", + "title":"Querying Weekly Defense Statistics", + "githuburl":"" + }, + { + "uri":"antiddos_02_0002.html", + "product_code":"antiddos", + "code":"15", + "des":"This API allows you to query all API versions.URI formatGET /GET /Request parametersNoneParameter descriptionNameTypeDescriptionversionsList data structureAPI versionsidS", + "doc_type":"api", + "kw":"Querying All API Versions,Anti-DDoS APIs,API Reference", + "title":"Querying All API Versions", + "githuburl":"" + }, + { + "uri":"antiddos_02_0007.html", + "product_code":"antiddos", + "code":"16", + "des":"This API allows you to query a specified API version.URI formatGET /{version_id}GET /{version_id}Request parametersNoneParameter descriptionNameTypeDescriptionversionData", + "doc_type":"api", + "kw":"Querying a Specified API Version,Anti-DDoS APIs,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"antiddos_02_0037.html", + "product_code":"antiddos", + "code":"17", + "des":"This API enables you to query the default protection policy configured for the newly purchased public IP addresses.URI formatGET /v1/{project_id}/antiddos/default-configG", + "doc_type":"api", + "kw":"Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses,Anti-D", + "title":"Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses", + "githuburl":"" + }, + { + "uri":"antiddos_02_0038.html", + "product_code":"antiddos", + "code":"18", + "des":"This API enables you to configure the default protection policy. After a protection policy is configured, it applies to the newly purchased public IP addresses.URI format", + "doc_type":"api", + "kw":"Configuring the Default Protection Policy for Newly Purchased Public IP Addresses,Anti-DDoS APIs,API", + "title":"Configuring the Default Protection Policy for Newly Purchased Public IP Addresses", + "githuburl":"" + }, + { + "uri":"antiddos_02_0028.html", + "product_code":"antiddos", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Reminding APIs", + "title":"Alarm Reminding APIs", + "githuburl":"" + }, + { + "uri":"antiddos_02_0029.html", + "product_code":"antiddos", + "code":"20", + "des":"This API allows you to query alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or email", + "doc_type":"api", + "kw":"Querying Alarm Configuration,Alarm Reminding APIs,API Reference", + "title":"Querying Alarm Configuration", + "githuburl":"" + }, + { + "uri":"antiddos_02_0041.html", + "product_code":"antiddos", + "code":"21", + "des":"This API allows you to update alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emai", + "doc_type":"api", + "kw":"Updating Alarm Configuration,Alarm Reminding APIs,API Reference", + "title":"Updating Alarm Configuration", + "githuburl":"" + }, + { + "uri":"antiddos_02_0030.html", + "product_code":"antiddos", + "code":"22", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"antiddos_02_0031.html", + "product_code":"antiddos", + "code":"23", + "des":"NormalReturned ValueDescription200The request is successfully processed.AbnormalStatus CodeStatusDescription400Bad RequestThe server fails to process the request.401Unaut", + "doc_type":"api", + "kw":"Status Code,Appendix,API Reference", + "title":"Status Code", + "githuburl":"" + }, + { + "uri":"antiddos_02_0034.html", + "product_code":"antiddos", + "code":"24", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/antiddos/api-ref/CLASS.TXT.json b/docs/antiddos/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..14843e93 --- /dev/null +++ b/docs/antiddos/api-ref/CLASS.TXT.json @@ -0,0 +1,218 @@ +[ + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"antiddos", + "title":"API Usage Guidelines", + "uri":"en-us_topic_0037386201.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"antiddos", + "title":"API", + "uri":"antiddos_02_0040.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"antiddos", + "title":"Anti-DDoS APIs", + "uri":"antiddos_02_0016.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API allows you to query optional Anti-DDoS defense policies. Based on your service, you can select a policy for Anti-DDoS traffic scrubbing.URI formatGET /v1/{projec", + "product_code":"antiddos", + "title":"Querying Optional Anti-DDoS Defense Policies", + "uri":"antiddos_02_0017.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This asynchronous API allows you to enable the Anti-DDoS traffic scrubbing. Successfully invoking this API only means that the service node has received the enabling requ", + "product_code":"antiddos", + "title":"Enabling Anti-DDoS", + "uri":"antiddos_02_0018.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"This asynchronous API allows you to disable the Anti-DDoS traffic scrubbing. Successfully invoking this API only means that the service node has received the disabling re", + "product_code":"antiddos", + "title":"Disabling Anti-DDoS", + "uri":"antiddos_02_0019.html", + "doc_type":"api", + "p_code":"3", + "code":"6" + }, + { + "desc":"This API enables you to query the Anti-DDoS defense policy of a specified EIP.URI formatGET /v1/{project_id}/antiddos/{floating_ip_id}GET /v1/{project_id}/antiddos/{float", + "product_code":"antiddos", + "title":"Querying Configured Anti-DDoS Defense Policies", + "uri":"antiddos_02_0020.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API enables you to update the Anti-DDoS defense policy of a specified EIP. Successfully invoking this API only means that the service node has received the update re", + "product_code":"antiddos", + "title":"Updating Anti-DDoS Defense Policies", + "uri":"antiddos_02_0021.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"This API enables you to query the execution status of a specified Anti-DDoS configuration task.URI formatGET /v1/{project_id}/query_task_statusYou can use ? and & behind ", + "product_code":"antiddos", + "title":"Querying Anti-DDoS Tasks", + "uri":"antiddos_02_0022.html", + "doc_type":"api", + "p_code":"3", + "code":"9" + }, + { + "desc":"This API enables you to query the defense statuses of all EIPs, regardless whether an EIP has been bound to an Elastic Cloud Server (ECS) or not.URI formatGET /v1/{projec", + "product_code":"antiddos", + "title":"Querying the List of Defense Statuses of EIPs", + "uri":"antiddos_02_0023.html", + "doc_type":"api", + "p_code":"3", + "code":"10" + }, + { + "desc":"This API allows you to query the defense status of a specified EIP.URI formatGET /v1/{project_id}/antiddos/{floating_ip_id}/statusGET /v1/{project_id}/antiddos/{floating_", + "product_code":"antiddos", + "title":"Querying the Defense Status of a Specified EIP", + "uri":"antiddos_02_0024.html", + "doc_type":"api", + "p_code":"3", + "code":"11" + }, + { + "desc":"This API allows you to query the traffic of a specified EIP in the last 24 hours. Traffic is detected in five-minute intervals.URI formatGET /v1/{project_id}/antiddos/{fl", + "product_code":"antiddos", + "title":"Querying the Traffic of a Specified EIP", + "uri":"antiddos_02_0025.html", + "doc_type":"api", + "p_code":"3", + "code":"12" + }, + { + "desc":"This API allows you to query events of a specified EIP in the last 24 hours. Events include cleaning and blackhole events, and the query delay is within five minutes.URI ", + "product_code":"antiddos", + "title":"Querying Events of a Specified EIP", + "uri":"antiddos_02_0026.html", + "doc_type":"api", + "p_code":"3", + "code":"13" + }, + { + "desc":"This API allows you to query weekly defense statistics about all your IP addresses, including the number of intercepted DDoS attacks, number of attacks, and ranking by th", + "product_code":"antiddos", + "title":"Querying Weekly Defense Statistics", + "uri":"antiddos_02_0027.html", + "doc_type":"api", + "p_code":"3", + "code":"14" + }, + { + "desc":"This API allows you to query all API versions.URI formatGET /GET /Request parametersNoneParameter descriptionNameTypeDescriptionversionsList data structureAPI versionsidS", + "product_code":"antiddos", + "title":"Querying All API Versions", + "uri":"antiddos_02_0002.html", + "doc_type":"api", + "p_code":"3", + "code":"15" + }, + { + "desc":"This API allows you to query a specified API version.URI formatGET /{version_id}GET /{version_id}Request parametersNoneParameter descriptionNameTypeDescriptionversionData", + "product_code":"antiddos", + "title":"Querying a Specified API Version", + "uri":"antiddos_02_0007.html", + "doc_type":"api", + "p_code":"3", + "code":"16" + }, + { + "desc":"This API enables you to query the default protection policy configured for the newly purchased public IP addresses.URI formatGET /v1/{project_id}/antiddos/default-configG", + "product_code":"antiddos", + "title":"Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses", + "uri":"antiddos_02_0037.html", + "doc_type":"api", + "p_code":"3", + "code":"17" + }, + { + "desc":"This API enables you to configure the default protection policy. After a protection policy is configured, it applies to the newly purchased public IP addresses.URI format", + "product_code":"antiddos", + "title":"Configuring the Default Protection Policy for Newly Purchased Public IP Addresses", + "uri":"antiddos_02_0038.html", + "doc_type":"api", + "p_code":"3", + "code":"18" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"antiddos", + "title":"Alarm Reminding APIs", + "uri":"antiddos_02_0028.html", + "doc_type":"api", + "p_code":"2", + "code":"19" + }, + { + "desc":"This API allows you to query alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or email", + "product_code":"antiddos", + "title":"Querying Alarm Configuration", + "uri":"antiddos_02_0029.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "desc":"This API allows you to update alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emai", + "product_code":"antiddos", + "title":"Updating Alarm Configuration", + "uri":"antiddos_02_0041.html", + "doc_type":"api", + "p_code":"19", + "code":"21" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"antiddos", + "title":"Appendix", + "uri":"antiddos_02_0030.html", + "doc_type":"api", + "p_code":"", + "code":"22" + }, + { + "desc":"NormalReturned ValueDescription200The request is successfully processed.AbnormalStatus CodeStatusDescription400Bad RequestThe server fails to process the request.401Unaut", + "product_code":"antiddos", + "title":"Status Code", + "uri":"antiddos_02_0031.html", + "doc_type":"api", + "p_code":"22", + "code":"23" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"antiddos", + "title":"Change History", + "uri":"antiddos_02_0034.html", + "doc_type":"api", + "p_code":"", + "code":"24" + } +] \ No newline at end of file diff --git a/docs/antiddos/api-ref/PARAMETERS.txt b/docs/antiddos/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/antiddos/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/antiddos/api-ref/antiddos_02_0002.html b/docs/antiddos/api-ref/antiddos_02_0002.html new file mode 100644 index 00000000..bafd1be1 --- /dev/null +++ b/docs/antiddos/api-ref/antiddos_02_0002.html @@ -0,0 +1,153 @@ + + +
This API allows you to query all API versions.
+Request parameters
+None
+Name + |
+Type + |
+Description + |
+
---|---|---|
versions + |
+List data structure + |
+API versions + |
+
id + |
+String + |
+Version ID (Version number), for example, v 1 + |
+
links + |
+List data structure + |
+URLs of the APIs + |
+
min_version + |
+String + |
+If this API version supports microversions, the minimum microversion number is returned. If microversions are not supported, no value is returned. + |
+
status + |
+String + |
+Version status. Valid values are as follows: +CURRENT: Indicates that the version is the primary version. +SUPPORTED: Indicates that the version is an old version, but it is still supported. +DEPRECATED: Indicates that this version is a discarded version and may be deleted later. + |
+
updated + |
+String + |
+Version release time + |
+
version + |
+String + |
+If this API version supports microversions, the maximum microversion number is returned. If microversions are not supported, no value is returned. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
href + |
+Yes + |
+String + |
+URLs of APIs + |
+
rel + |
+Yes + |
+String + |
+self + |
+
GET /+
{ + "versions": [ + { + "id": "v1", + "links": [ + { + "href": "https://antiddos.eu-de.otc.t-systems.com/v1/", + "rel": "self" + } + ], + "min_version": "", + "status": "CURRENT", + "updated": "2016-10-29T00:00:00Z", + "version": "" + }, + { + "id": "v2", + "links": [ + { + "href": "https://antiddos.eu-de.otc.t-systems.com/v2/", + "rel": "self" + } + ], + "min_version": "", + "status": "CURRENT", + "updated": "2018-09-18T00:00:00Z", + "version": "" + } + ] +}+
For details, see Status Code.
+This API allows you to query a specified API version.
+Request parameters
+None
+Name + |
+Type + |
+Description + |
+
---|---|---|
version + |
+Data structure + |
+Version object + |
+
id + |
+String + |
+Version ID (Version number), for example, v 1 + |
+
links + |
+List data structure + |
+URL of the API + |
+
min_version + |
+String + |
+If this API version supports microversions, the minimum microversion number is returned. If microversions are not supported, no value is returned. + |
+
status + |
+String + |
+Version status. Valid values are as follows: +CURRENT: Indicates that the version is the primary version. +SUPPORTED: Indicates that the version is an old version, but it is still supported. +DEPRECATED: Indicates that this version is a discarded version and may be deleted later. + |
+
updated + |
+String + |
+Version release time + |
+
version + |
+String + |
+If this API version supports microversions, the maximum microversion number is returned. If microversions are not supported, no value is returned. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
href + |
+Yes + |
+String + |
+URL of the API + |
+
rel + |
+Yes + |
+String + |
+self + |
+
GET /v1+
{ + "version": + { + "id": "v1", + "links": [ + { + "href": "https://antiddos.eu-de.otc.t-systems.com/v1/", + "rel": "self" + } + ], + "min_version": "", + "status": "CURRENT", + "updated": "2016-10-29T00:00:00Z", + "version": "" + } +}+
For details, see Status Code.
+This API allows you to query optional Anti-DDoS defense policies. Based on your service, you can select a policy for Anti-DDoS traffic scrubbing.
+Request parameters
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
traffic_limited_list + |
+Yes + |
+List data structure + |
+List of traffic limits + |
+
http_limited_list + |
+Yes + |
+List data structure + |
+List of HTTP limits + |
+
connection_limited_list + |
+Yes + |
+List data structure + |
+List of limits of numbers of connections + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
traffic_pos_id + |
+Yes + |
+Integer + |
+Position ID of traffic + |
+
traffic_per_second + |
+Yes + |
+Integer + |
+Threshold of traffic per second (Mbit/s) + |
+
packet_per_second + |
+Yes + |
+Integer + |
+Threshold of number of packets per second + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
http_request_pos_id + |
+Yes + |
+Integer + |
+Position ID of number of HTTP requests + |
+
http_packet_per_second + |
+Yes + |
+Integer + |
+Threshold of number of HTTP requests per second + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
cleaning_access_pos_id + |
+Yes + |
+Integer + |
+Position ID of access limit during cleaning + |
+
new_connection_limited + |
+Yes + |
+Integer + |
+Number of new connections of a source IP address + |
+
total_connection_limited + |
+Yes + |
+Integer + |
+Total number of connections of a source IP address + |
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/query_config_list+
{ + "traffic_limited_list": [ + { + "traffic_pos_id": 1, + "traffic_per_second": 10, + "packet_per_second": 2000 + }, + { + "traffic_pos_id": 2, + "traffic_per_second": 30, + "packet_per_second": 6000 + }, + { + "traffic_pos_id": 3, + "traffic_per_second": 50, + "packet_per_second": 10000 + }, + { + "traffic_pos_id": 4, + "traffic_per_second": 70, + "packet_per_second": 15000 + }, + { + "traffic_pos_id": 5, + "traffic_per_second": 100, + "packet_per_second": 20000 + }, + { + "traffic_pos_id": 6, + "traffic_per_second": 150, + "packet_per_second": 25000 + }, + { + "traffic_pos_id": 7, + "traffic_per_second": 200, + "packet_per_second": 35000 + }, + { + "traffic_pos_id": 8, + "traffic_per_second": 250, + "packet_per_second": 50000 + }, + { + "traffic_pos_id": 9, + "traffic_per_second": 300, + "packet_per_second": 70000 + } + ], + "http_limited_list": [ + { + "http_request_pos_id": 1, + "http_packet_per_second": 100 + }, + { + "http_request_pos_id": 2, + "http_packet_per_second": 150 + }, + { + "http_request_pos_id": 3, + "http_packet_per_second": 240 + }, + { + "http_request_pos_id": 4, + "http_packet_per_second": 350 + }, + { + "http_request_pos_id": 5, + "http_packet_per_second": 480 + }, + { + "http_request_pos_id": 6, + "http_packet_per_second": 550 + }, + { + "http_request_pos_id": 7, + "http_packet_per_second": 700 + }, + { + "http_request_pos_id": 8, + "http_packet_per_second": 850 + }, + { + "http_request_pos_id": 9, + "http_packet_per_second": 1000 + }, + { + "http_request_pos_id": 10, + "http_packet_per_second": 1500 + }, + { + "http_request_pos_id": 11, + "http_packet_per_second": 2000 + }, + { + "http_request_pos_id": 12, + "http_packet_per_second": 3000 + }, + { + "http_request_pos_id": 13, + "http_packet_per_second": 5000 + }, + { + "http_request_pos_id": 14, + "http_packet_per_second": 10000 + }, + { + "http_request_pos_id": 15, + "http_packet_per_second": 20000 + } + ], + "connection_limited_list": [ + { + "cleaning_access_pos_id": 1, + "new_connection_limited": 10, + "total_connection_limited": 30 + }, + { + "cleaning_access_pos_id": 2, + "new_connection_limited": 20, + "total_connection_limited": 100 + }, + { + "cleaning_access_pos_id": 3, + "new_connection_limited": 30, + "total_connection_limited": 200 + }, + { + "cleaning_access_pos_id": 4, + "new_connection_limited": 40, + "total_connection_limited": 250 + }, + { + "cleaning_access_pos_id": 5, + "new_connection_limited": 50, + "total_connection_limited": 300 + }, + { + "cleaning_access_pos_id": 6, + "new_connection_limited": 60, + "total_connection_limited": 500 + }, + { + "cleaning_access_pos_id": 7, + "new_connection_limited": 70, + "total_connection_limited": 600 + }, + { + "cleaning_access_pos_id": 8, + "new_connection_limited": 80, + "total_connection_limited": 700 + } + ], + "extend_ddos_config": [ + { + "new_connection_limited": 80, + "total_connection_limited": 700, + "http_packet_per_second": 500000, + "traffic_per_second": 1000, + "packet_per_second": 200000, + "setID": 33 + }, + { + "new_connection_limited": 80, + "total_connection_limited": 700, + "http_packet_per_second": 500000, + "traffic_per_second": 2000, + "packet_per_second": 200000, + "setID": 34 + }, + { + "new_connection_limited": 80, + "total_connection_limited": 700, + "http_packet_per_second": 500000, + "traffic_per_second": 5000, + "packet_per_second": 400000, + "setID": 35 + }, + { + "new_connection_limited": 80, + "total_connection_limited": 700, + "http_packet_per_second": 0, + "traffic_per_second": 0, + "packet_per_second": 0, + "setID": 36 + } + ] +}+
The extend_ddos_config field displays information about Anti-DDoS defense policies set by users based on their needs.
+See Status Code.
+This asynchronous API allows you to enable the Anti-DDoS traffic scrubbing. Successfully invoking this API only means that the service node has received the enabling request. You need to use the task querying API to check the task execution status. For details about the task querying API, see Querying Anti-DDoS Tasks.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
enable_L7 + |
+No + |
+Boolean + |
+Whether to enable L7 defense + |
+
traffic_pos_id + |
+Yes + |
+Integer + |
+Position ID of traffic. The value ranges from 1 to 9 and 33 to 36. + |
+
http_request_pos_id + |
+Yes + |
+Integer + |
+Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36. + |
+
cleaning_access_pos_id + |
+Yes + |
+Integer + |
+Position ID of access limit during cleaning. The value ranges from 1 to 8 and 33 to 36. + |
+
app_type_id + |
+No + |
+Integer + |
+Application type ID. Possible values:
+
|
+
If values of traffic_pos_id, http_request_pos_id, cleaning_access_pos_id are set between 33 to 36, their values must be the same.
+Name + |
+Type + |
+Description + |
+
---|---|---|
error_code + |
+String + |
+Internal error code + |
+
error_description + |
+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 use in task auditing later. It is temporarily unused. + |
+
POST /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8+
{ + "enable_L7":true, + "traffic_pos_id":1, + "http_request_pos_id":1, + "cleaning_access_pos_id":1, + "app_type_id":1 +}+
{ + "error_code": "10000000", + "error_description": "Task has been received and is being processed.", + "task_id": "94e17e18-5b2c-40c6-a218-8ec5134e32a5" +}+
See Status Code.
+This asynchronous API allows you to disable the Anti-DDoS traffic scrubbing. Successfully invoking this API only means that the service node has received the disabling request. You need to use the task querying API to check the task execution status. For details about the task querying API, see Querying Anti-DDoS Tasks.
+None
+Name + |
+Type + |
+Description + |
+
---|---|---|
error_code + |
+String + |
+Internal error code + |
+
error_description + |
+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 use in task auditing later. It is temporarily unused. + |
+
DELETE /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8+
{ + "error_code": "10000000", + "error_description": "Task has been received and is being processed.", + "task_id": "d90dc577-abd2-4be0-b2cf-cb8f5f67ddb0" +}+
See Status Code.
+This API enables you to query the Anti-DDoS defense policy of a specified EIP.
+Request parameters
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
enable_L7 + |
+Yes + |
+Boolean + |
+Whether L7 defense has been enabled. + |
+
traffic_pos_id + |
+Yes + |
+Integer + |
+Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36. + |
+
http_request_pos_id + |
+Yes + |
+Integer + |
+Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36. + |
+
cleaning_access_pos_id + |
+Yes + |
+Integer + |
+Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36. + |
+
app_type_id + |
+Yes + |
+Integer + |
+Application type ID. Possible values:
+
|
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8+
{ + "enable_L7": true, + "traffic_pos_id": 1, + "http_request_pos_id": 1, + "cleaning_access_pos_id": 1, + "app_type_id": 1 +}+
See Status Code.
+This API enables you to update the Anti-DDoS defense policy of a specified EIP. Successfully invoking this API only means that the service node has received the update request. You need to use the task querying API to check the task execution status. For details about the task querying API, see Querying Anti-DDoS Tasks.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
enable_L7 + |
+No + |
+Boolean + |
+Whether to enable L7 defense + |
+
traffic_pos_id + |
+Yes + |
+Integer + |
+Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36. + |
+
http_request_pos_id + |
+Yes + |
+Integer + |
+Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36. + |
+
cleaning_access_pos_id + |
+Yes + |
+Integer + |
+Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36. + |
+
app_type_id + |
+No + |
+Integer + |
+Application type ID. Possible values:
+
|
+
If values of traffic_pos_id, http_request_pos_id, cleaning_access_pos_id are set between 33 to 36, their values must be the same.
+Name + |
+Type + |
+Description + |
+
---|---|---|
error_code + |
+String + |
+Internal error code + |
+
error_description + |
+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 use in task auditing later. It is temporarily unused. + |
+
PUT /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/ee0c854e-082f-499e-b7d8-1b42c22781af+
{ + "enable_L7":false, + "traffic_pos_id":2, + "http_request_pos_id":1, + "cleaning_access_pos_id":1, + "app_type_id":1 +}+
{ + "error_code": "10000000", + "error_description": "Task has been received and is being processed.", + "task_id": "4a4fefe7-34a1-40e2-a87c-16932af3ac4a" +}+
See Status Code.
+This API enables you to query the execution status of a specified Anti-DDoS configuration task.
+GET /v1/{project_id}/query_task_status
+You can use ? and & behind the URI to add query conditions, as shown in the request example.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
project_id + |
+Yes + |
+String + |
+User ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
task_id + |
+Yes + |
+String + |
+Task ID (nonnegative integer) character string + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
task_status + |
+String + |
+Status of a task, which can be one of the following:
+
|
+
task_msg + |
+String + |
+Additional information about a task + |
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/query_task_status?task_id=4a4fefe7-34a1-40e2-a87c-16932af3ac4a+
{ + "task_status": "running", + "task_msg": "" +}+
See Status Code.
+This API enables you to query the defense statuses of all EIPs, regardless whether an EIP has been bound to an Elastic Cloud Server (ECS) or not.
+You can use ? and & behind the URI to add query conditions, as shown in the request example.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
project_id + |
+Yes + |
+String + |
+User ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
status + |
+No + |
+String + |
+Possible values:
+
If this parameter is not used, the defense statuses of all ECSs are displayed in the Neutron-queried order by default. + |
+
limit + |
+No + |
+Integer + |
+Maximum number of returned results. The value ranges from 1 to 100. + |
+
offset + |
+No + |
+Integer + |
+Offset. The value ranges from 0 to 2147483647. + |
+
ip + |
+No + |
+String + |
+IP address. Both IPv4 and IPv6 addresses are supported. For example, if you enter ?ip=192.168, the defense status of EIPs corresponding to 192.168.111.1 and 10.192.168.8 is returned. + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
total + |
+Integer + |
+Total number of EIPs + |
+
ddosStatus + |
+List data structure + |
+List of defense statuses + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
floating_ip_address + |
+Yes + |
+String + |
+Floating IP address + |
+
floating_ip_id + |
+Yes + |
+String + |
+ID of an EIP + |
+
network_type + |
+Yes + |
+String + |
+EIP type. The value can be: +
|
+
status + |
+Yes + |
+String + |
+Defense status, the possible value of which is one of the following:
+
|
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos?status=packetdropping+
{ + "total": 5, + "ddosStatus": [ + { + "floating_ip_id": "1867f954-fc11-4202-8247-6af2144867ea", + "floating_ip_address": "192.168.42.221", + "network_type": "EIP", + "status": "notConfig" + }, + { + "floating_ip_id": "49c6af49-9ace-42e6-ab89-1eee1f4ac821", + "floating_ip_address": "192.168.35.152", + "network_type": "EIP", + "status": "normal" + }, + { + "floating_ip_id": "7a8dc957-083b-499d-b7cf-6fa48f4880c5", + "floating_ip_address": "192.168.42.222", + "network_type": "EIP", + "status": "notConfig" + }, + { + "floating_ip_id": "7c6676a0-b281-4163-9d0d-cb6485ae9860", + "floating_ip_address": "192.168.44.69", + "network_type": "EIP", + "status": "normal" + }, + { + "floating_ip_id": "969c1d48-6a92-4ef1-b66c-b17c7e7d7ce7", + "floating_ip_address": "192.168.47.192", + "network_type": "EIP", + "status": "notConfig" + } + ] +}+
See Status Code.
+This API allows you to query the defense status of a specified EIP.
+Request parameters
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
status + |
+Yes + |
+String + |
+Defense status, the possible value of which is one of the following:
+
|
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8/status+
{"status": "normal"}+
See Status Code.
+This API allows you to query the traffic of a specified EIP in the last 24 hours. Traffic is detected in five-minute intervals.
+Request parameters
+None
+Name + |
+Type + |
+Description + |
+
---|---|---|
data + |
+Data structure + |
+Traffic in the last 24 hours + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
period_start + |
+Yes + |
+Long integer + |
+Start time + |
+
bps_in + |
+Yes + |
+Integer + |
+Inbound traffic (bit/s) + |
+
bps_attack + |
+Yes + |
+Integer + |
+Attack traffic (bit/s) + |
+
total_bps + |
+Yes + |
+Integer + |
+Total traffic + |
+
pps_in + |
+Yes + |
+Integer + |
+Inbound packet rate (number of packets per second) + |
+
pps_attack + |
+Yes + |
+Integer + |
+Attack packet rate (number of packets per second) + |
+
total_pps + |
+Yes + |
+Integer + |
+Total packet rate + |
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8/daily+
{"data": [ + { + "period_start": 1472713370609, + "bps_in": 0, + "bps_attack": 0, + "total_bps": 0, + "pps_in": 0, + "pps_attack": 0, + "total_pps": 0 + }, + + + ... + + + { + "period_start": 1472713670609, + "bps_in": 0, + "bps_attack": 0, + "total_bps": 0, + "pps_in": 0, + "pps_attack": 0, + "total_pps": 0 + }] +}+
See Status Code.
+This API allows you to query events of a specified EIP in the last 24 hours. Events include cleaning and blackhole events, and the query delay is within five minutes.
+GET /v1/{project_id}/antiddos/{floating_ip_id}/logs
+You can use ? and & behind the URI to add query conditions, as shown in the request example.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
project_id + |
+Yes + |
+String + |
+User ID + |
+
floating_ip_id + |
+Yes + |
+String + |
+ID corresponding to the EIP of a user + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
limit + |
+No + |
+Integer + |
+Limit of number of returned results or the maximum number of returned results of a query. The value ranges from 1 to 100, and this parameter is used together with the offset parameter. +If neither limit nor offset is used, query results of all ECSs are returned. + |
+
offset + |
+No + |
+Integer + |
+Offset. This parameter is valid only when used together with the limit parameter. + |
+
sort_dir + |
+No + |
+String + |
+Possible values:
+
The default value is desc. + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
total + |
+Integer + |
+Total number of EIPs + |
+
logs + |
+Data structure + |
+List of events + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
start_time + |
+Yes + |
+Long integer + |
+Start time + |
+
end_time + |
+Yes + |
+Long integer + |
+End time + |
+
status + |
+Yes + |
+Integer + |
+Defense status, the possible value of which is one of the following:
+
|
+
trigger_bps + |
+Yes + |
+Integer + |
+Traffic at the triggering point + |
+
trigger_pps + |
+Yes + |
+Integer + |
+Packet rate at the triggering point + |
+
trigger_http_pps + |
+Yes + |
+Integer + |
+HTTP request rate at the triggering point + |
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/1df977c2-fdc6-4483-bc1c-ba46829f57b8/logs+
{ + "total": 1, + "logs": [ + { + "start_time": 1473217200000, + "end_time": 1473242400000, + "status": 1, + "trigger_bps": 51106, + "trigger_pps": 2600, + "trigger_http_pps": 3589 + } + ] +}+
See Status Code.
+This API allows you to query weekly defense statistics about all your IP addresses, including the number of intercepted DDoS attacks, number of attacks, and ranking by the number of attacks. Currently, you can query weekly statistics up to four weeks before the current time. Data older than four weeks cannot be queried.
+GET /v1/{project_id}/antiddos/weekly
+You can use ? and & behind the URI to add query conditions, as shown in the request example.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
project_id + |
+Yes + |
+String + |
+User ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
period_start_date + |
+No + |
+String + |
+Start date of a seven-day period + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
ddos_intercept_times + |
+Integer + |
+Number of DDoS attacks blocked in a week + |
+
weekdata + |
+Data structure + |
+Number of attacks in a week + |
+
top10 + |
+Data structure + |
+Top 10 attacked IP addresses + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
ddos_intercept_times + |
+Yes + |
+Integer + |
+Number of DDoS attacks blocked + |
+
ddos_blackhole_times + |
+Yes + |
+Integer + |
+Number of DDoS black holes + |
+
max_attack_bps + |
+Yes + |
+Integer + |
+Maximum attack traffic + |
+
max_attack_conns + |
+Yes + |
+Integer + |
+Maximum number of attack connections + |
+
period_start_date + |
+Yes + |
+Long integer + |
+Start time + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
floating_ip_address + |
+Yes + |
+String + |
+EIP + |
+
times + |
+Yes + |
+Integer + |
+Number of DDoS attacks intercepted, including cleaning operations and black holes + |
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/weekly?period_start_date=1006510306+
{ + "ddos_intercept_times": 23, + "weekdata": [ + { + "ddos_intercept_times": 0, + "ddos_blackhole_times": 0, + "max_attack_bps": 0, + "max_attack_conns": 0, + "period_start_date": 1474214461651 + }, + { + "ddos_intercept_times": 0, + "ddos_blackhole_times": 0, + "max_attack_bps": 0, + "max_attack_conns": 0, + "period_start_date": 1474300861651 + }, + { + "ddos_intercept_times": 0, + "ddos_blackhole_times": 0, + "max_attack_bps": 0, + "max_attack_conns": 0, + "period_start_date": 1474387261651 + }, + { + "ddos_intercept_times": 0, + "ddos_blackhole_times": 0, + "max_attack_bps": 0, + "max_attack_conns": 0, + "period_start_date": 1474473661651 + }, + { + "ddos_intercept_times": 0, + "ddos_blackhole_times": 0, + "max_attack_bps": 0, + "max_attack_conns": 0, + "period_start_date": 1474560061651 + }, + { + "ddos_intercept_times": 2, + "ddos_blackhole_times": 0, + "max_attack_bps": 16375, + "max_attack_conns": 0, + "period_start_date": 1474646461651 + }, + { + "ddos_intercept_times": 1, + "ddos_blackhole_times": 0, + "max_attack_bps": 0, + "max_attack_conns": 0, + "period_start_date": 1474732861651 + } + ], + "top10": [ + { + "floating_ip_address": "192.168.44.69", + "times": 23 + } + ] +}+
See Status Code.
+This API allows you to query alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emails.
+Request parameters
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
warn_config + |
+Yes + |
+List data structure + |
+Alarm configuration + |
+
topic_urn + |
+Yes + |
+String + |
+ID of an alarm group + |
+
display_name + |
+Yes + |
+String + |
+Description of an alarm group + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
antiDDoS + |
+Yes + |
+Boolean + |
+DDoS attacks + |
+
bruce_force + |
+No + |
+Boolean + |
+Brute force cracking (system logins, FTP, and DB) + |
+
remote_login + |
+No + |
+Boolean + |
+Alarms about remote logins + |
+
weak_password + |
+No + |
+Boolean + |
+Weak passwords (system and database) + |
+
high_privilege + |
+No + |
+Boolean + |
+Overly high rights of a database process + |
+
back_doors + |
+No + |
+Boolean + |
+Webshells + |
+
waf + |
+No + |
+Boolean + |
+Reserved + |
+
send_frequency + |
+No + |
+Integer + |
+Possible values: +
|
+
GET /v2/67641fe6886f43fcb78edbbf0ad0b99f/warnalert/alertconfig/query+
{ + "warn_config": { + "antiDDoS": true, + "bruce_force": false, + "remote_login": false, + "weak_password": false, + "high_privilege": false, + "back_doors": false, + "waf": false + }, + "topic_urn": "urn:smn:eu-de:67641fe6886f43fcb78edbbf0ad0b99f:test_soft", + "display_name": "group_1" +}+
SFTP is more secure than FTP. To secure data transmission, use SFTP to transfer files.
+See Status Code.
+Returned Value + |
+Description + |
+
---|---|
200 + |
+The request is successfully processed. + |
+
Status Code + |
+Status + |
+Description + |
+
---|---|---|
400 + |
+Bad Request + |
+The server fails to process the request. + |
+
401 + |
+Unauthorized + |
+The requested page requires a username and a password. + |
+
403 + |
+Forbidden + |
+Access to the requested page is denied. + |
+
404 + |
+Not Found + |
+The server fails to find the requested page. + |
+
405 + |
+Method Not Allowed + |
+Method specified in the request is not allowed. + |
+
406 + |
+Not Acceptable + |
+Response generated by the server is not acceptable to the client. + |
+
407 + |
+Proxy Authentication Required + |
+Proxy authentication is required before the request is processed. + |
+
408 + |
+Request Timeout + |
+A timeout error occurs because the request is not processed within the specified waiting period of the server. + |
+
409 + |
+Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 + |
+Internal Server Error + |
+The request is not processed due to a server error. + |
+
501 + |
+Not Implemented + |
+The request is not processed because the server does not support the requested function. + |
+
502 + |
+Bad Gateway + |
+The request is not processed, and the server receives an invalid response from the upstream server. + |
+
503 + |
+Service Unavailable + |
+The request is not processed due to a temporary system abnormality. + |
+
504 + |
+Gateway Timeout + |
+A gateway timeout error occurs. + |
+
Release Date + |
+Description + |
+
---|---|
2022-09-30 + |
+Updated examples in section "Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses". + |
+
2020-07-08 + |
+Added section "Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses". +Added section "Configuring the Default Protection Policy for Newly Purchased Public IP Addresses". + |
+
2020-03-10 + |
+
|
+
2019-12-09 + |
+
|
+
2018-09-30 + |
+Added sections "Querying All API Versions" and "Querying a Specified API Version". + |
+
2017-04-28 + |
+Updated examples in section "Querying Optional Anti-DDoS Defense Policies". + |
+
2016-11-24 + |
+
|
+
2016-10-29 + |
+This is the first official release. + |
+
This API enables you to query the default protection policy configured for the newly purchased public IP addresses.
+Request parameters
+None
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
enable_L7 + |
+Yes + |
+Boolean + |
+Whether to enable layer-7 protection. + |
+
traffic_pos_id + |
+Yes + |
+Integer + |
+Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36. + |
+
http_request_pos_id + |
+Yes + |
+Integer + |
+Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36. + |
+
cleaning_access_pos_id + |
+Yes + |
+Integer + |
+Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36. + |
+
app_type_id + |
+Yes + |
+Integer + |
+Application type ID. Possible values:
+
|
+
GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default/config+
{ + "enable_L7":true, + "traffic_pos_id":1, + "http_request_pos_id":1, + "cleaning_access_pos_id":1, + "app_type_id":1 +}+
For details, see Status Code.
+This API enables you to configure the default protection policy. After a protection policy is configured, it applies to the newly purchased public IP addresses.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
enable_L7 + |
+Yes + |
+Boolean + |
+Whether to enable layer-7 protection. + |
+
traffic_pos_id + |
+Yes + |
+Integer + |
+Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36. + |
+
http_request_pos_id + |
+Yes + |
+Integer + |
+Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36. + |
+
cleaning_access_pos_id + |
+Yes + |
+Integer + |
+Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36. + |
+
app_type_id + |
+Yes + |
+Integer + |
+Application type ID. Possible values:
+
|
+
If values of traffic_pos_id, http_request_pos_id, cleaning_access_pos_id are set between 33 to 36, their values must be the same.
+Name + |
+Type + |
+Description + |
+
---|---|---|
statusCode + |
+String + |
+Internal error code + |
+
body + |
+String + |
+Internal error description + |
+
header + |
+String + |
+Internal error code header + |
+
POST /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default/config+
{ + "enable_L7":true, + "traffic_pos_id":1, + "http_request_pos_id":1, + "cleaning_access_pos_id":1, + "app_type_id":1 +}+
{ + "statusCode": 0, + "body": null, + "header": null +}+
For details, see Status Code.
+This API allows you to update alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emails.
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
warn_config + |
+Yes + |
+List data structure + |
+Alarm configuration + |
+
topic_urn + |
+Yes + |
+String + |
+ID of an alarm group + |
+
display_name + |
+Yes + |
+String + |
+Description of an alarm group + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
antiDDoS + |
+Yes + |
+Boolean + |
+DDoS attacks + |
+
bruce_force + |
+No + |
+Boolean + |
+Brute force cracking (system logins, FTP, and DB) + |
+
remote_login + |
+No + |
+Boolean + |
+Alarms about remote logins + |
+
weak_password + |
+No + |
+Boolean + |
+Weak passwords (system and database) + |
+
high_privilege + |
+No + |
+Boolean + |
+Overly high rights of a database process + |
+
back_doors + |
+No + |
+Boolean + |
+Webshells + |
+
waf + |
+No + |
+Boolean + |
+Reserved + |
+
send_frequency + |
+No + |
+Integer + |
+Possible values: +
|
+
SFTP is more secure than FTP. To secure data transmission, use SFTP to transfer files.
+{ + "warn_config": { + "antiDDoS": true, + "bruce_force": false, + "remote_login": false, + "weak_password": false, + "high_privilege": false, + "back_doors": false, + "waf": false + }, + "topic_urn": "urn:smn:eu-de:67641fe6886f43fcb78edbbf0ad0b99f:test_soft", + "display_name": "group_1" +}+
For details, see Status Code.
+Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+