Log Service allows you to collect and manage logs by using the Log Service console. In addition, you can use API operations to write logs, query logs, and manage your projects and Logstores.

The following tables list the API operations available for use in Log Service.

Service operationOpenSlsService and GetSlsService
ProjectListProject, CreateProject, DeleteProject, GetProject, and UpdateProject
GetProjectLogs (Queries all logs in a project)
Logtail configurationListConfig, CreateConfig, DeleteConfig, GetConfig, and UpdateConfig
GetAppliedMachineGroups (Queries the machine groups to which a Logtail configuration is applied)
Machine groupListMachineGroup, CreateMachineGroup, DeleteMachineGroup, GetMachineGroup, and UpdateMachineGroup
ApplyConfigToMachineGroup and RemoveConfigFromMachineGroup (Deletes a Logtail configuration)
GetAppliedConfigs (Queries the Logtail configurations that are applied)
LogstoreListLogStores, CreateLogStore, DeleteLogStore, GetLogStore, and UpdateLogStore
GetLogs (Queries logs) and GetHistograms (Queries the distribution of logs)
IndexCreateIndex, UpdateIndex, DeleteIndex, and GetIndex
ShardListShards, SplitShard, and MergeShard
PutLogs (Writes logs)
GetCursor (Locates logs)
PullLogs (Consumes logs)
Log shipping ruleGetShipperStatus(Queries the status of a log shipping job)
RetryShipperTask (Retries a failed log shipping job)
Consumer groupCreateConsumerGroup, UpdateConsumerGroup, DeleteConsumerGroup, and ListConsumerGroup
HeartBeat (Sends heartbeat packets), GetCheckPoint, and UpdateCheckPoint
External storeCreateExternalStore, DeleteExternalStore, GetExternalStore, ListExternalStore, and UpdateExternalStore
AlertCreateAlert, UpdateAlert, DeleteAlert, GetAlert, and ListAlert
Saved searchCreateSavedSearch, DeleteSavedSearch, GetSavedSearch, and ListSavedSearch
  • To properly call operations, we recommend that you understand endpoints. An endpoint is a URL that allows access to each project in the region of Log Service and the logs in the projects. For more information, see Endpoints.
  • Authentication is required for all API requests. The "Request signatures" topic describes the mechanism and process of request signing. For more information, see Request signatures.
  • You can call operations by using Resource Access Management (RAM) and Security Token Services (STS). If you use a RAM user, you must provide an AccessKey pair for authentication when you call operations. If you call operations by using STS, you must provide a temporary credential and use a special HTTP header. For more information, see Common request headers and Request signatures.
  • You can configure user-specific access control. For more information, see Overview.