All Products
Search
Document Center

Security Center:DescribeLogStore

Last Updated:Dec 28, 2023

Queries the information about a Logstore that is used in the threat analysis feature of Simple Log Service on the user side. The information may be the Logstore name or the time-to-live (TTL) period of data in the Logstore.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:DescribeLogStoreRead
  • acs:yundun-sas::{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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

  • cn-hangzhou: Your assets reside in regions inside the Chinese mainland or in the China (Hong Kong) region.
  • ap-southeast-1: Your assets reside in regions outside the Chinese mainland, excluding the China (Hong Kong) region.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

CloudSiemResponse

Dataobject

The response of the threat analysis feature.

LogStoreNamestring

The name of the Logstore in Simple Log Service.

cloud-siem
Ttlinteger

The retention period of data. Unit: day.

180
ShardCountinteger

The number of shards in Log Service.

2
EnableTrackingboolean

Indicates whether the web tracking feature is enabled to collect user information from browsers, iOS applications, or Android applications. Valid values:

  • true
  • false
false
AutoSplitboolean

Indicates whether the automatic sharding feature is enabled. Valid values:

  • true
  • false
false
MaxSplitShardinteger

The maximum number of shards that can be generated by using the automatic sharding feature.

64
AppendMetaboolean

Indicates whether the following time points are added after the log arrives: the time points when the public IP address of the client and the log arrive. Valid values:

  • true
  • false
false
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codeinteger

The HTTP status code.

200
Messagestring

The returned message.

success
ErrCodestring

The error code.

Request.Forbidden
RequestIdstring

The request ID.

9B9CBCEE-9225-5069-BC7F-880938A2****
DyCodestring

The dynamic error code.

DeleteJobConfigError
DyMessagestring

The dynamic message.

Task[%s] is submitting, please try it later

Examples

Sample success responses

JSONformat

{
  "Data": {
    "LogStoreName": "cloud-siem",
    "Ttl": 180,
    "ShardCount": 2,
    "EnableTracking": false,
    "AutoSplit": false,
    "MaxSplitShard": 64,
    "AppendMeta": false
  },
  "Success": true,
  "Code": 200,
  "Message": "success",
  "ErrCode": "Request.Forbidden",
  "RequestId": "9B9CBCEE-9225-5069-BC7F-880938A2****",
  "DyCode": "DeleteJobConfigError",
  "DyMessage": "Task[%s] is submitting, please try it later"
}

Error codes

HTTP status codeError codeError message
501CloudSiem_Internal_ExceptionCloudSiem_Internal_Exception

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

Change history

Change timeSummary of changesOperation
2023-12-13The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 501
    Added Error Codes: 500
Output ParametersThe response structure of the API has changed.