Upgrade Log Analysis Settings via ResetLogShipper API - Security Center - Alibaba Cloud - Security Center

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:ResetLogShipper

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Ttl	integer	No	The global log retention period. Note Supported only when the log analysis feature uses the pay-as-you-go billing method.	180
HotTtl	integer	No	The global retention period of hot data. Note The value must be at least 7 and smaller than the log retention period. Unit: days.	7
LogMetaList	array<object>	No	The settings of the log analysis feature.
	object	No	The setting of the log analysis feature.
ConfigLogStore	string	No	The Logstore to configure. Note Call the DescribeLogMeta operation to query the Logstore.	sas-security-log
Status	string	No	The status of the log analysis feature. Valid values: disabled enabled	enabled
Ttl	integer	No	The log retention period of the Logstore. Note If you specify this parameter for the Logstore, it overrides the global log retention period specified by the Ttl parameter.	60
HotTtl	integer	No	The retention period of hot data in the Logstore. Note The value must be at least 7 and smaller than the log retention period. Unit: days. If you specify this parameter for the Logstore, it overrides the global retention period of hot data specified by the HotTtl parameter.	7

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D2E31293-DAAC-574B-B816-A18EA0A6****

Examples

Success response

JSON format

{
  "RequestId": "D2E31293-DAAC-574B-B816-A18EA0A6****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalHotTTL	The hot storage TTL is invalid.	The hot storage data must be stored for at least 7 days and must be less than the data storage time.
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.