All Products
Search
Document Center

:ListLogConfigs

Last Updated:Aug 01, 2024

Queries the logging configurations of an application.

Debugging

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

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
sae:ListLogConfigsget
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/sam/log/listLogConfigs

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

10

56f77b65-788d-442a-9885-7f20d91f****
PageSizeintegerYes

1

10
CurrentPageintegerYes

The ID of the request.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The returned message.

  • success is returned when the request succeeds.
  • An error code is returned when the request fails.
91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The ID of the trace. It can be used to query the details of a request.

success
TraceIdstring

The logging configurations.

ac1d5e2c15671581252413581d****
Dataobject

The details of logging configurations.

LogConfigsarray<object>

The name of the Log Service configuration.

object
ConfigNamestring

The path of logs.

sae-1f240907a6faf58c653f09e81b7e****
LogDirstring

The name of the Logstore in Log Service.

/root/logs/hsf/hsf.log
SlsLogStorestring

The time when the configuration was created.

sae-1f240907a6faf58c653f09e81b7e****
CreateTimestring

The storage type of logs.

2019-08-29 17:18:00
StoreTypestring

The ID of the Log Service project.

sls
SlsProjectstring

The type of the log. Set this value to file_log.

sae-56f77b65-788d-442a-9885-7f20d91f****
LogTypestring

The ID of the region.

file_log
RegionIdstring

The number of the returned page.

cn-beijing
CurrentPageinteger

The total number of returned entries.

1
TotalSizeinteger

The number of entries returned on each page.

1
PageSizeinteger

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
10
ErrorCodestring

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
Codestring

Indicates whether the logging configurations of an application were obtained. Valid values:

  • true: indicates that the configurations were obtained.
  • false: indicates that the configurations could not be obtained.
200

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history