International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Serverless Cloud Function
    Documentation
    Download PDF

    GetFunctionLogs

    Last updated: 2021-07-23 19:49:56
    Download PDF

    1. API Description

    Domain name for API request: scf.tencentcloudapi.com.

    This API is used to return function running logs according to the specified log query criteria.

    A maximum of 5 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: scf.ap-shanghai-fsi.tencentcloudapi.com

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: GetFunctionLogs.
    Version Yes String Common parameter. The value used for this API: 2018-04-16.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    FunctionName No String Function name.
    - To ensure the compatibility of the GetFunctionLogs API, the input parameter FunctionName is optional, but we recommend you enter it; otherwise, log acquisition may fail.
    - After the function is connected to CLS, we recommend you use the related CLS API to get the best log retrieval experience.
    Offset No Integer Data offset. The addition of Offset and Limit cannot exceed 10,000.
    Limit No Integer Length of the return data. The addition of Offset and Limit cannot exceed 10,000.
    Order No String It specifies whether to sort the logs in an ascending or descending order. The value is desc or asc.
    OrderBy No String It specifies the sorting order of the logs based on a specified field, such as function_name, duration, mem_usage, and start_time.
    Filter No LogFilter Log filter used to identify whether to return logs of successful or failed requests. filter.RetCode=not0 indicates that only the logs of failed requests will be returned. filter.RetCode=is0 indicates that only the logs of successful requests will be returned. If this parameter is left blank, all logs will be returned.
    Namespace No String Function namespace
    Qualifier No String Function version
    FunctionRequestId No String RequestId corresponding to the executed function
    StartTime No Timestamp Query date, for example, 2017-05-16 20:00:00. The date must be within one day of the end time.
    EndTime No Timestamp Query date, for example, 2017-05-16 20:59:59. The date must be within one day of the start time.
    SearchContext No LogSearchContext This field is disused.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of function logs
    Data Array of FunctionLog Function log information
    SearchContext LogSearchContext This field is disused.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting function execution log

    Input Example

    https://scf.tencentcloudapi.com/?Action=GetFunctionLogs
&FunctionName=<FunctionName>
&<Common request parameters>

    Output Example

    {
  "Response": {
    "TotalCount": 1,
    "Data": [
      {
        "MemUsage": 3174400,
        "RetCode": 1,
        "RetMsg": "Success",
        "Log": "",
        "BillDuration": 100,
        "InvokeFinished": 1,
        "RequestId": "bc309eaa-6d64-11e8-a7fe-5254000b4175",
        "StartTime": "2018-06-11 18:46:45",
        "Duration": 0.532,
        "FunctionName": "APITest",
        "Level": "",
        "Source": "",
        "RetryNum": 1
      }
    ],
    "SearchContext": {
      "Offset": "",
      "Limit": 0,
      "Keyword": "",
      "Type": ""
    },
    "RequestId": "e2571ff3-da04-4c53-8438-f58bf057ce4a"
  }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InternalError Internal error.
    InternalError.ES ES error.
    InternalError.Exception Internal service error
    InternalError.System Internal system error.
    InvalidParameter.Payload Invalid request parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.DateTime DateTime error.
    InvalidParameterValue.Offset Invalid offset.
    InvalidParameterValue.Order Order error.
    InvalidParameterValue.OrderBy The value of OrderBy does not conform to the specification. Please fix it and try again. For more information, please visit https://tencentcs.com/5jXKFnBW.
    InvalidParameterValue.RetCode Invalid RetCode
    InvalidParameterValue.StartTimeOrEndTime You need to specify both the start time and the end time.
    LimitExceeded.Offset Offset exceeds the upper limit.
    ResourceNotFound.Function The function does not exist.
    ResourceNotFound.FunctionName The function does not exist.
    UnauthorizedOperation.CAM CAM authentication failed.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy