ListLogConfigs - Serverless App Engine - Alibaba Cloud Documentation Center

Returns a list of application logs.

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

sae:ListLogConfigs

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/log/listLogConfigs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	56f77b65-788d-442a-9885-7f20d91f****
PageSize	integer	Yes	The number of entries to return on each page. Valid values: 1 to 10000.	10
CurrentPage	integer	Yes	The page number.	1

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. If the request is successful, success is returned. If the request fails, an error code is returned.	success
TraceId	string	The trace ID of the request. You can use the trace ID to query the details of the request.	ac1d5e2c15671581252413581d****
Data	object	The information about the file logs.
LogConfigs	array<object>	The log configurations.
	object	The log configuration.
ConfigName	string	The name of the Simple Log Service configuration.	sae-1f240907a6faf58c653f09e81b7e****
LogDir	string	The path of the log file. This is the log source.	/root/logs/hsf/hsf.log
SlsLogStore	string	The name of the Logstore in Simple Log Service.	sae-1f240907a6faf58c653f09e81b7e****
CreateTime	string	The time when the log configuration was created.	2019-08-29 17:18:00
StoreType	string	The storage class for Simple Log Service.	sls
SlsProject	string	The ID of the Simple Log Service project.	sae-56f77b65-788d-442a-9885-7f20d91f****
LogType	string	The log type. Only file_log is supported.	file_log
RegionId	string	The region ID.	cn-beijing
CurrentPage	integer	The page number.	1
TotalSize	integer	The total number of entries.	1
PageSize	integer	The number of entries returned per page.	10
ErrorCode	string	The error code. This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes list in this topic.	空
Code	string	The HTTP status code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: A request error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the list of application logs was obtained. Valid values: true: The list was obtained. false: The list failed to be obtained.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1d5e2c15671581252413581d****",
  "Data": {
    "LogConfigs": [
      {
        "ConfigName": "sae-1f240907a6faf58c653f09e81b7e****",
        "LogDir": "/root/logs/hsf/hsf.log",
        "SlsLogStore": "sae-1f240907a6faf58c653f09e81b7e****",
        "CreateTime": "2019-08-29 17:18:00",
        "StoreType": "sls",
        "SlsProject": "sae-56f77b65-788d-442a-9885-7f20d91f****",
        "LogType": "file_log",
        "RegionId": "cn-beijing"
      }
    ],
    "CurrentPage": 1,
    "TotalSize": 1,
    "PageSize": 10
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.