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 20 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
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: ListFunctions. |
| 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. |
| 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. |
| 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. |
This example shows you how to query functions whose status tag is dev and owner tag is me.
https://scf.tencentcloudapi.com/?Action=ListFunctions
&Limit=2
&Order=ASC
&<Common request parameters>{
"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"
}
],
"RequestId": "xx"
}
}This example shows you how to query functions whose status tag is dev and owner tag is me.
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>{
"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"
}
],
"RequestId": "xx"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.Namespace | Namespace error. |
| InvalidParameterValue.Offset | Invalid offset. |
| InvalidParameterValue.Order | Order error. |
| InvalidParameterValue.Orderby | Orderby error. |
| ResourceNotFound.Namespace | Namespace does not exist. |
| UnauthorizedOperation.CAM | CAM authentication failed. |
| UnauthorizedOperation.Region | Region error. |
Was this page helpful?