1. 接口描述
接口请求域名： scf.tencentcloudapi.com 。
该接口根据传入的查询参数返回相关函数信息。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListFunctions。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Order | 否 | String | 以升序还是降序的方式返回结果，可选值 ASC 和 DESC 示例值：ASC |
| Orderby | 否 | String | 根据哪个字段进行返回结果排序,支持以下字段：AddTime, ModTime, FunctionName 示例值：ModTime |
| Offset | 否 | Integer | 数据偏移量，默认值为 0 示例值：0 |
| Limit | 否 | Integer | 返回数据长度，默认值为 20 示例值：2 |
| SearchKey | 否 | String | 支持FunctionName模糊匹配 示例值：hello-world |
| Namespace | 否 | String | 命名空间 示例值：default |
| Description | 否 | String | 函数描述，支持模糊搜索 示例值：test |
| Filters.N | 否 | Array of Filter | 过滤条件。 - tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的Filters的上限为10，Filter.Values的上限为5。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Functions | Array of Function | 函数列表 |
| TotalCount | Integer | 总数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取函数列表
输入示例
https://scf.tencentcloudapi.com/?Action=ListFunctions
&Limit=2
&Order=ASC
&<公共请求参数>输出示例
{
"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"
}
}示例2 根据标签查询函数
查询status标签的值是dev，且owner标签的值是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
&<公共请求参数>输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.Exception | 内部服务异常。 |
| InternalError.System | 内部系统错误。 |
| InvalidParameter.Payload | 请求参数不合法。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Limit | Limit传入错误。 |
| InvalidParameterValue.LimitExceeded | 参数超出长度限制。 |
| InvalidParameterValue.Name | Name参数传入错误。 |
| InvalidParameterValue.Namespace | Namespace参数传入错误。 |
| InvalidParameterValue.Offset | 偏移量不合法。 |
| InvalidParameterValue.Order | Order传入错误。 |
| InvalidParameterValue.Orderby | Orderby传入错误。 |
| InvalidParameterValue.QueryVersion | 查询版本详情，版本参数传入错误。 |
| ResourceNotFound.Namespace | Namespace不存在。 |
| UnauthorizedOperation.CAM | CAM鉴权失败。 |
| UnauthorizedOperation.Region | Region错误。 |
