All Products
Search
Document Center

Security Center:DescribeLogMeta

Last Updated:Nov 13, 2024

Queries the configurations of the log analysis feature provided by Security Center.

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:DescribeLogMetaget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

123.168.XX.XX
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
FromstringNo

The ID of the request source. Default value: aegis. Valid values:

  • aegis: Server Guard
  • sas: Security Center
Note If you use Server Guard, set the value to aegis. If you use Security Center, set the value to sas.
sas
ResourceDirectoryAccountIdlongNo

The Alibaba Cloud account ID of the member in the resource directory.

Note You can call the DescribeMonitorAccounts operation to obtain the IDs.
127608589417****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

TotalCountinteger

The total number of entries returned.

100
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

D0D6E6E4-CB8C-4897-B852-46AEFDA04B21
LogMetaListarray<object>

An array that consists of the configurations of the log analysis feature.

LogMetaobject

The configurations of the log analysis feature.

LogDescstring

The name of the log type.

Login
Statusstring

The status of the log analysis feature. Valid values:

  • disabled
  • enabled
enabled
LogStorestring

The name of the dedicated Logstore in which logs are stored.

aegis-log-login
UserProjectstring

The name of the dedicated project in which logs are stored.

sasnew-log-XXXX-cn-hangzhou
Categorystring

The category of logs. Valid values:

  • host
  • network
  • security
host
Projectstring

The name of the project.

aegis-log
UserLogStorestring

The name of the dedicated Logstore in which user logs are stored.

aegis-log-network
UserRegionstring

The ID of the region.

cn-hangzhou
Ttlinteger

The number of days during which logs can be retained.

180
HotTtlinteger

The time period after which logs in hot storage are moved to cold storage. Unit: days.

Note If the value is -1, logs that are stored in hot storage are not moved to cold storage.
-1
Topicstring

The topic of logs that are delivered.

aegis-log-login

Examples

Sample success responses

JSONformat

{
  "TotalCount": 100,
  "RequestId": "D0D6E6E4-CB8C-4897-B852-46AEFDA04B21",
  "LogMetaList": [
    {
      "LogDesc": "Login",
      "Status": "enabled",
      "LogStore": "aegis-log-login",
      "UserProject": "sasnew-log-XXXX-cn-hangzhou",
      "Category": "host",
      "Project": "aegis-log",
      "UserLogStore": "aegis-log-network",
      "UserRegion": "cn-hangzhou",
      "Ttl": 180,
      "HotTtl": -1,
      "Topic": "aegis-log-login"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500RdCheckInnerErrorResource directory account service internal error.-
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2024-10-08The Error code has changedView Change Details
2024-05-30The Error code has changed. The request parameters of the API has changedView Change Details
2022-12-23API Description Update. The API operation is not deprecated.View Change Details