All Products
Search
Document Center

Security Center:ListDelivery

Last Updated:Jan 10, 2025

Queries the information about the cloud services that are integrated with the threat analysis feature, the logs of the cloud services, and the delivery of the logs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListDeliverylist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RoleTypeintegerNo

The type of the view. Valid values:

  • 0: the current Alibaba Cloud account
  • 1: the global account
1
RoleForlongNo

The ID of the account that you switch from the management account.

113091674488****
RegionIdstringNo

The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:

  • cn-hangzhou: Your assets reside in regions in China.
  • ap-southeast-1: Your assets reside in regions outside China.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

BaseResponse

Dataobject

The response parameters.

ProjectNamestring

The name of the project for the threat analysis feature in Simple Log service on the user side. The value is in the aliyun-cloudsiem-data-${aliUid}-${region} format.

aliyun-cloudsiem-data-127608589417****-cn-shanghai
LogStoreNamestring

The name of the Logstore for the threat analysis feature on the user side. The value is in the cloud_siem format.

cloud-siem
SearchUrlstring

The URL that is used for log analysis.

https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai /logsearch/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true
DashboardUrlstring

The URL that is displayed in charts.

https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai /dashboard/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true
DisplaySwitchOrNotboolean

Indicates whether the log delivery switch is displayed. Default value: true. Valid values:

  • true
  • false
true
ProductListarray<object>

The cloud services.

ProductListobject
ProductCodestring

The code of the cloud service. Valid values:

  • qcloud_waf
  • qlcoud_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
ProductNamestring

This parameter is deprecated.

Security Center
LogMapobject

The log group. For example, in Security Center, the logs of hosts and networks are stored in different groups. Key indicates the group information, and value indicates the logs in the group.

array<object>

The logs in a log group.

Itemobject
LogCodestring

The code of the log.

cloud_siem_config_log
LogNamestring

This parameter is deprecated.

audit log
LogNameEnstring

This parameter is deprecated.

audit log
LogNameKeystring

The language code of the log that is used to indicate the language in which the log is displayed.

${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}
Statusboolean

The status of the log delivery. Valid values:

  • true: The logs are being delivered.
  • false: The log delivery feature is disabled.
true
CanOperateOrNotboolean

Indicates whether the log delivery feature can be enabled or disabled. The feature can be enabled or disabled only by the administrator of the threat analysis feature. Valid values:

  • true
  • false
true
Topicstring

The topic of the log in the Logstore. The value is an index field in the Logstore that can be used to distinguish different logs.

sas_login_event
ExtraParametersarray<object>

The extended parameter.

ExtraParameterobject
Keystring

The ID of the extended parameter.

flag
Valuestring

The value of the extended parameter.

value
LogListarray<object>

The logs of the cloud services.

LogListobject
LogCodestring

The code of the log.

cloud_siem_config_log
LogNamestring

This parameter is deprecated.

audit log
LogNameEnstring

This parameter is deprecated.

audit log
LogNameKeystring

The language code of the log that is used to indicate the language in which the log is displayed.

${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}
Statusboolean

The status of the log delivery. Valid values:

  • true: The logs are being delivered.
  • false: The log delivery feature is disabled.
true
CanOperateOrNotboolean

Indicates whether the log delivery feature can be enabled or disabled. The feature can be enabled or disabled only by the administrator of the threat analysis feature. Valid values:

  • true
  • false
true
Topicstring

The topic of the log in the Logstore. The value is an index field in the Logstore that can be used to distinguish different logs.

sas_login_event
ExtraParametersarray<object>

The extended parameter.

ExtraParameterobject
Keystring

The ID of the extended parameter.

flag
Valuestring

The value of the extended parameter.

value
RequestIdstring

The request ID.

6276D891-58D4-55B2-87B9-74D413F7****

Examples

Sample success responses

JSONformat

{
  "Data": {
    "ProjectName": "aliyun-cloudsiem-data-127608589417****-cn-shanghai",
    "LogStoreName": "cloud-siem",
    "SearchUrl": "https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai\n/logsearch/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true",
    "DashboardUrl": "https://sls4service.console.aliyun.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 codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.
500SLS.Sls4Service.ErrorThe Simple Log Service about embedding console pages is unavailable.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-17The Error code has changed. The request parameters of the API has changedView Change Details
2023-12-13The Error code has changed. The response structure of the API has changedView Change Details