DescribeBatchSlsDispatchStatus - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the status of log delivery.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response message. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the response message. Valid values: en : English zh : Chinese	zh

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	7036EBAB-F85F-5AAE-976F-C75AEE59****
LogstoreName	string	The name of the Logstore in Simple Log Service.	rs-stats
ProjectName	string	The name of the project in Simple Log Service.	cloudfirewallnew-project-199053910542****-cn-hangzhou
ItemList	array<object>	A list of Simple Log Service projects.
	object	The list of log delivery configurations.
DispatchName	string	The name of the log delivery.	互联网流量日志
DispatchValue	string	The value of the log to be delivered.	internet_log
SearchName	string	The name of the search type.	log_type
Enable	boolean	The delivery status.	true
ConfigStatus	string	The status of the delivery configuration.	success_finished
FilterKeys	array	The supported filter conditions.
	string	The supported filter conditions. Valid values: other : Other attack : Attack acl : ACL	attack
LogVersion	string	The log version. A value of 1 indicates that there is one Logstore. A value of 2 indicates that there are two Logstores.	1
InfoList	array<object>	A list of detailed information about the Logstores.
	array<object>	The list of information.
LogstoreName	string	The name of the Logstore in Simple Log Service.	cloudfirewall-logstore
ProjectName	string	The name of the project in Simple Log Service.	cloudfirewall-project-1204872307283650-cn-hangzhou
ItemList	array<object>	The details of the log delivery configuration.
	object	The details of the log delivery configuration.
DispatchName	string	The name of the delivery type.	互联网流量日志、VPC流量日志、NAT流量日志
DispatchValue	string	The key for the log categorization. Valid values: internet_log vpc_firewall_log nat_firewall_log ipv6_firewall_log dns_firewall_log	ipv6_firewall_log
SearchName	string	The value is fixed to log_type. You can ignore this parameter.	log_type
Enable	boolean	Indicates whether this delivery type is enabled.	true
ConfigStatus	string	The configuration status.	success_finished
FilterKeys	array	The detailed delivery configurations for the Internet and VPCs.
	string	The specific field name. `attack` indicates attack event logs. `acl` indicates access control logs. `other` indicates all other types of logs.	attack,other
Site	string	`cn` indicates the Chinese mainland. `intl` indicates regions outside the Chinese mainland. `global` indicates global.	cn

Examples

Success response

JSON format

{
  "RequestId": "7036EBAB-F85F-5AAE-976F-C75AEE59****",
  "LogstoreName": "rs-stats",
  "ProjectName": "cloudfirewallnew-project-199053910542****-cn-hangzhou",
  "ItemList": [
    {
      "DispatchName": "互联网流量日志",
      "DispatchValue": "internet_log",
      "SearchName": "log_type",
      "Enable": true,
      "ConfigStatus": "success_finished",
      "FilterKeys": [
        "attack"
      ]
    }
  ],
  "LogVersion": "1",
  "InfoList": [
    {
      "LogstoreName": "cloudfirewall-logstore",
      "ProjectName": "cloudfirewall-project-1204872307283650-cn-hangzhou",
      "ItemList": [
        {
          "DispatchName": "互联网流量日志、VPC流量日志、NAT流量日志",
          "DispatchValue": "ipv6_firewall_log",
          "SearchName": "log_type",
          "Enable": true,
          "ConfigStatus": "success_finished",
          "FilterKeys": [
            "attack,other"
          ]
        }
      ],
      "Site": "cn"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvokeError	Invoke rosttea's api failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.