Call the ListConfig operation to query Logtail configurations - Simple Log Service

Operation description

Usage notes

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project.

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

log:ListConfig

list

*Project

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*

log:TLSVersion

None

Request syntax

GET /configs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
logstoreName	string	Yes	The name of the Logstore.	ali-test-logstore
offset	integer	Yes	The line from which the query starts. Default value: 0.	0
size	integer	Yes	The number of entries per page. Maximum value: 500.	10
configName	string	No	The name of the Logtail configuration, which is used for fuzzy match.	logtail-config-sample

Response elements

Element	Type	Description	Example
	object
count	integer	The number of Logtail configurations that are returned on the current page.	3
total	integer	The total number of Logtail configurations that meet the query conditions.	2
configs	array	The Logtail configurations that are returned on the current page.
	string	The Logtail configuration that is returned.	logtail-config-sample

Examples

Success response

JSON format

{
  "count": 3,
  "total": 2,
  "configs": [
    "logtail-config-sample"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.