tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListFunctions

Last updated: 2023-05-05 10:16:45

1. API Description

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

This API is used to return relevant function information based on the input query parameters.

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

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 Params. The value used for this API: ListFunctions.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Order No String It specifies whether to return the results in ascending or descending order. The value is ASC or DESC.
Orderby No String It specifies the sorting order of the results according to a specified field, such as AddTime, ModTime, and FunctionName.
Offset No Integer Data offset. The default value is 0.
Limit No Integer Return data length. The default value is 20.
SearchKey No String It specifies whether to support fuzzy matching for the function name.
Namespace No String Namespace
Description No String Function description. Fuzzy search is supported.
Filters.N No Array of Filter Filters
- tag:tag-key - String - Required: No - Filtering criteria based on tag-key - value pairs. Replace tag-key with a specific tag-key.

The maximum number of Filters for each request is 10, and that of Filter.Values is 5.

3. Output Parameters

Parameter Name Type Description
Functions Array of Function Function list
TotalCount Integer Total number
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the list of functions

This example shows you how to query functions whose status tag is dev and owner tag is me.

Input Example

https://scf.tencentcloudapi.com/?Action=ListFunctions
&Limit=2
&Order=ASC
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Functions": [
            {
                "ModTime": "xx",
                "Status": "xx",
                "StatusDesc": "xx",
                "FunctionName": "xx",
                "TotalProvisionedConcurrencyMem": 1,
                "Tags": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "AddTime": "xx",
                "Namespace": "xx",
                "StatusReasons": [
                    {
                        "ErrorCode": "xx",
                        "ErrorMessage": "xx"
                    }
                ],
                "Runtime": "xx",
                "Type": "xx",
                "FunctionId": "xx",
                "ReservedConcurrencyMem": 1,
                "Description": "xx",
                "TraceEnable": "FALSE",
                "AsyncRunEnable": "FALSE"
            }
        ],
        "RequestId": "xx"
    }
}

Example2 Querying functions associated with the specified tags

This example shows how to query functions with the tags of status:dev and owner:me.

Input Example

https://scf.tencentcloudapi.com/?Action=ListFunctions
&Filters.0.Name=tag-status
&Filters.0.Values.0=dev
&Filters.1.Name=tag-owner
&Filters.1.Values.0=me
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Functions": [
            {
                "ModTime": "xx",
                "Status": "xx",
                "StatusDesc": "xx",
                "FunctionName": "xx",
                "TotalProvisionedConcurrencyMem": 1,
                "Tags": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "AddTime": "xx",
                "Namespace": "xx",
                "StatusReasons": [
                    {
                        "ErrorCode": "xx",
                        "ErrorMessage": "xx"
                    }
                ],
                "Runtime": "xx",
                "Type": "xx",
                "FunctionId": "xx",
                "ReservedConcurrencyMem": 1,
                "Description": "xx",
                "TraceEnable": "FALSE",
                "AsyncRunEnable": "FALSE"
            }
        ],
        "RequestId": "xx"
    }
}

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
InternalError.Exception Internal service error
InternalError.System Internal system error.
InvalidParameter.Payload Invalid request parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Limit Limit error.
InvalidParameterValue.LimitExceeded The parameter exceeds the length limit.
InvalidParameterValue.Name Incorrect Name parameter.
InvalidParameterValue.Namespace Namespace error.
InvalidParameterValue.Offset Invalid offset.
InvalidParameterValue.Order Order error.
InvalidParameterValue.Orderby Orderby error.
InvalidParameterValue.QueryVersion Version parameter error
ResourceNotFound.Namespace Namespace does not exist.
UnauthorizedOperation.CAM CAM authentication failed.
UnauthorizedOperation.Region Region error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy