ListDelivery - Security Center - Alibaba Cloud Documentation Center

Lists the products and logs that are connected to threat analysis for an enterprise or a member, and the data shipping status of these logs.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListDelivery

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RoleType	integer	No	The type of view. Valid values: 0: The view for the current Alibaba Cloud account. 1: The view for all accounts in the enterprise.	1
RoleFor	integer	No	The Alibaba Cloud account ID of a member. An administrator can use this parameter to view data from the perspective of the member.	113091674488****
RegionId	string	No	The region of the data management center for threat analysis. Select the region based on where your assets are located. Valid values: cn-hangzhou: Select this value if your assets are in the Chinese mainland or China (Hong Kong). ap-southeast-1: Select this value if your assets are in regions outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	BaseResponse
Data	object	The returned data.
ProjectName	string	The name of your Simple Log Service (SLS) project for threat analysis. The format is `aliyun-cloudsiem-data-${aliUid}-${region}`.	aliyun-cloudsiem-data-127608589417****-cn-shanghai
LogStoreName	string	The name of your LogStore for threat analysis. The format is `cloud_siem`.	cloud-siem
SearchUrl	string	The URL of the Search & Analysis page in the SLS console.	https://sls4servims.console.alibabacloud.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai /logsearch/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true
DashboardUrl	string	The URL of the dashboard on the log analysis page.	https://sls4servims.console.alibabacloud.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai /dashboard/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true
DisplaySwitchOrNot	boolean	Indicates whether to display the delivery switch. The default value is true. Valid values: true: The delivery switch is displayed. false: The delivery switch is hidden.	true
ProductList	array<object>	A list of products.
	object	The products that are connected.
ProductCode	string	The code of the cloud product. Valid values: qcloud_waf qcloud_cfw hcloud_waf hcloud_cfw ddos sas cfw config csk fc rds nas apigateway cdn mongodb eip slb vpc actiontrail waf bastionhost oss polardb	sas
ProductName	string	This parameter is deprecated. You can ignore it.	Security Center
LogMap	object	A list of logs that are categorized. For example, Security Center logs are categorized into groups such as Host and Network. The group is the key, and the logs in the group are the value.
	array	A list of logs in the group.
LogList	array<object>	A list of logs for cloud products that do not have subcategories.
	object	The details of the log.
LogCode	string	The log code.	cloud_siem_config_log
LogName	string	This parameter is deprecated. You can ignore it.	audit log
LogNameEn	string	This parameter is deprecated. You can ignore it.	audit log
LogNameKey	string	The language key of the log name. This key is used to display the log name in different languages.	${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}
Status	boolean	The log delivery status. Valid values: true: Delivery is in progress. false: Delivery is disabled.	true
CanOperateOrNot	boolean	Indicates whether the log delivery switch can be operated. Only the delegated administrator for threat analysis can operate the switch. Valid values: true: The switch can be operated. false: The switch cannot be operated.	true
Topic	string	The topic of the log in the LogStore. This parameter is an index field in the LogStore and is used to differentiate logs.	sas_login_event
ExtraParameters	array<object>	Additional parameters.
	object	The additional parameters for the log description.
Key	string	The key of the additional parameter.	flag
Value	string	The value of the additional parameter.	value
RequestId	string	The request ID.	6276D891-58D4-55B2-87B9-74D413F7****

Examples

Success response

JSON format

{
  "Data": {
    "ProjectName": "aliyun-cloudsiem-data-127608589417****-cn-shanghai",
    "LogStoreName": "cloud-siem",
    "SearchUrl": "https://sls4servims.console.alibabacloud.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai\n/logsearch/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true",
    "DashboardUrl": "https://sls4servims.console.alibabacloud.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai\n/dashboard/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true",
    "DisplaySwitchOrNot": true,
    "ProductList": [
      {
        "ProductCode": "sas",
        "ProductName": "Security Center",
        "LogMap": {
          "key": [
            {
              "LogCode": "cloud_siem_config_log",
              "LogName": "audit log",
              "LogNameEn": "audit log",
              "LogNameKey": "${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}",
              "Status": true,
              "CanOperateOrNot": true,
              "Topic": "sas_login_event",
              "ExtraParameters": [
                {
                  "Key": "flag",
                  "Value": "value"
                }
              ]
            }
          ]
        },
        "LogList": [
          {
            "LogCode": "cloud_siem_config_log",
            "LogName": "audit log",
            "LogNameEn": "audit log\n",
            "LogNameKey": "${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}",
            "Status": true,
            "CanOperateOrNot": true,
            "Topic": "sas_login_event",
            "ExtraParameters": [
              {
                "Key": "flag",
                "Value": "value"
              }
            ]
          }
        ]
      }
    ]
  },
  "RequestId": "6276D891-58D4-55B2-87B9-74D413F7****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.
500	SLS.Sls4Service.Error	The Simple Log Service about embedding console pages is unavailable.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.