Deleting a Security Report Subscription
Function
This API is used to delete a security report subscription.
Calling Method
For details, see Calling APIs.
URI
DELETE /v1/{project_id}/waf/security-report/subscriptions/{subscription_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
subscription_id |
Yes |
String |
Definition Subscription ID, which uniquely identifies the security report subscription to be deleted. The value can be obtained by calling the security report subscription list API. Constraints N/A Range N/A Default Value N/A |
project_id |
Yes |
String |
Definition Tenant project ID, which is used to identify the project to which the tenant belongs. To obtain the project ID, log in to the console, click the username, choose My Credentials, locate the project in the Projects list, and check the project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition Tenant token, which is used for identity authentication. You can obtain the token by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range Length: 32 to 4096 characters Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type, which specifies the data format of the request body. Constraints N/A Range Length: 32 to 64 characters Default Value application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
subscription_id |
String |
Definition Subscription ID, which uniquely identifies the current security report subscription. Constraints N/A Range N/A Default Value N/A |
sending_period |
String |
Definition Preset time frame to send the report. For example, morning indicates the security report will be sent in the morning. Constraints N/A Range N/A Default Value N/A |
report_name |
String |
Definition Report name, which is the name of the security report to be subscribed to. Constraints N/A Range N/A Default Value N/A |
report_category |
String |
Definition Report type you want to subscribe; for example, daily_report indicates the daily security report. Constraints N/A Range N/A Default Value N/A |
topic_urn |
String |
Definition Topic URN, which is the unique ID of the SMN topic to which the subscription report is sent. Constraints N/A Range N/A Default Value N/A |
subscription_type |
String |
Definition Subscription type, which indicates the subscription mode of the security report. For example, silent indicates silent subscription. Constraints N/A Range N/A Default Value N/A |
report_content_subscription |
report_content_subscription object |
Definition Report content subscription, which is used to configure the enabling status of a specific statistics module contained in the subscription report. Constraints N/A Range N/A Default Value N/A |
stat_period |
stat_period object |
Definition Statistical period, which is the default statistical time range of the subscription report. Constraints N/A Range N/A Default Value N/A |
is_all_enterprise_project |
Boolean |
Definition Whether the subscription is applicable to all enterprise projects of the current tenant. (true: yes; false: no). Constraints N/A Range Only true and false are supported. Default Value false |
enterprise_project_id |
String |
Definition Enterprise project ID, which uniquely identifies the enterprise project associated with the subscription. This parameter is valid only when is_all_enterprise_project is set to false. Constraints N/A Range N/A Default Value N/A |
Parameter |
Type |
Description |
---|---|---|
overview_statistics_enable |
Boolean |
Definition Whether to enable the overview statistics (true: yes; false: no). Constraints N/A Range Only true and false are supported. Default Value true |
group_by_day_enable |
Boolean |
Definition Whether to enable the daily statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
request_statistics_enable |
Boolean |
Definition Whether to enable the request count statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
qps_statistics_enable |
Boolean |
Definition Whether to enable the QPS statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
bandwidth_statistics_enable |
Boolean |
Definition Whether to enable the bandwidth statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
response_code_statistics_enable |
Boolean |
Definition Whether to enable the response code statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
attack_type_distribution_enable |
Boolean |
Definition Whether to enable the attack type distribution statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
top_attacked_domains_enable |
Boolean |
Definition Whether to enable the top attacked domain name statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
top_attack_source_ips_enable |
Boolean |
Definition Whether to enable the top attacked source IP address statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
top_attacked_urls_enable |
Boolean |
Definition Whether to enable the top attacked URL statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
top_attack_source_locations_enable |
Boolean |
Definition Whether to enable the top attacked source geographical location statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
top_abnormal_urls_enable |
Boolean |
Definition Whether to enable the top abnormal URL statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true |
Parameter |
Type |
Description |
---|---|---|
begin_time |
Long |
Definition Start time, which is the start timestamp (in milliseconds) of the subscription report statistics period. Constraints N/A Range N/A Default Value N/A |
end_time |
Long |
Definition End time, which is the end timestamp (in milliseconds) of the subscription report statistics period. Constraints N/A Range N/A Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
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