产品文档



函数计算



帮助中心 > 函数计算 > describeFunctions

搜本产品



describeFunctions

描述

支持查询某个服务下的一个或多个函数的详细信息
此接口支持分页查询，默认每页20条。

请求方式

GET

请求地址

https://fc.jdcloud-api.com/v1/regions/{regionId}/services/{serviceName}/functions

名称	类型	是否必需	示例值	描述
regionId	String	True	cn-north-1	地域ID，函数当前支持如下地域： cn-north-1（华北-北京） cn-south-1（华南-广州）
serviceName	String	True	myservice	服务名称。

请求参数

名称	类型	是否必需	示例值	描述
pageNumber	Integer	False	1	页码；默认为1
pageSize	Integer	False	20	分页大小；默认为20；取值范围[10, 100]
filters	Filter[]	False		name - 实例名称，模糊匹配，支持单个

Filter

名称	类型	是否必需	示例值	描述
name	String	True	name	过滤条件的名称。
operator	String	False	eq	过滤条件的操作符，默认eq。
values	String[]	True	myfunction	过滤条件的值。

返回参数

名称	类型	描述
result	Result	响应结果。
requestId	String	请求ID。

Result

名称	类型	描述
functions	Function[]	函数配置。
totalCount	Number	本次查询可匹配到的总记录数，使用者需要结合`pageNumber` 和`pageSize` 计算是否可以继续分页。

Function

名称	类型	描述
functionId	String	函数 ID。
functionName	String	函数名称。
serviceId	String	服务 ID。
serviceName	String	服务名称。
checkSum	String	部署包的 sha256 hash。
codeSize	Integer	部署包的大小，单位为Bytes。
description	String	描述信息。
envs	Environment[]	环境变量配置。
runtime	String	函数运行的语言环境。
timeout	Integer	函数运行的超时时间，单位为秒。
handler	String	函数执行的入口，具体格式和语言相关。
cpu	Number	vCPU：单位为核。
memorySize	Integer	内存：单位为MB。
diskSize	Integer	硬盘：单位为MB。
invocationCount	Integer	函数调用统计次数。
createTime	String	函数创建时间。
updateTime	String	函数更新时间。
status	String	函数状态，Pending, Failed, Active。

Environment

名称	类型	描述
name	String	环境变量名称。
value	String	环境变量的值。

示例

GET
调用方法、签名算法及公共请求参数请参考京东云OpenAPI公共说明。

请求示例

v1/regions/cn-north-1/services/mytest6/functions?filters.1.name=name&filters.1.values.1=function

返回示例

{
    "requestId": "6d58f68e9888fe3cbfddb254e5d6fa17",
    "result": {
        "functions": [
            {
                "functionId": "fc-**mb",
                "functionName": "my-function-**1",
                "serviceName": "mytest6",
                "serviceId": "sv-**ir",
                "checkSum": "92b9d1cbd235ac2515656d847ca72c714f0aebb8863151cef03c086a1c684658",
                "codeSize": 217,
                "description": "My function description2",
                "envs": [
                    {
                        "name": "MY_ENV_VAR1",
                        "value": "my-value1"
                    }
                ],
                "timeout": 20,
                "handler": "index.handler",
                "runtime": "nodejs16",
                "cpu": 1,
                "memorySize": 4096,
                "diskSize": 512,
                "invocationCount": 0,
                "createTime": "2023-07-06 20:10:04",
                "updateTime": "2023-07-06 20:11:18",
                "status": "Active"
            },
            {
                "functionId": "fc-**fs",
                "functionName": "my-function-**2",
                "serviceName": "mytest6",
                "serviceId": "sv-**ir",
                "checkSum": "2f49629d0d19e7ba370bdca6dfd7d86dadc81a0958b2e71e6a5ae1867e845797",
                "codeSize": 189,
                "description": "My function description",
                "envs": [
                    {
                        "name": "--FC_FUNCTION_VERSION",
                        "value": "my-value"
                    }
                ],
                "timeout": 900,
                "handler": "index.handler",
                "runtime": "nodejs16",
                "cpu": 1,
                "memorySize": 4096,
                "diskSize": 512,
                "invocationCount": 0,
                "createTime": "2023-06-28 16:31:24",
                "updateTime": "2023-06-28 16:31:26",
                "status": "Failed"
            },
            {
                "functionId": "fc-**u2",
                "functionName": "my-function-**3",
                "serviceName": "mytest6",
                "serviceId": "sv-**ir",
                "checkSum": "92b9d1cbd235ac2515656d847ca72c714f0aebb8863151cef03c086a1c684658",
                "codeSize": 217,
                "description": "My function description2",
                "envs": [
                    {
                        "name": "MY_ENV_VAR1",
                        "value": "my-value1"
                    }
                ],
                "timeout": 900,
                "handler": "index.handler",
                "runtime": "nodejs16",
                "cpu": 1,
                "memorySize": 4096,
                "diskSize": 512,
                "invocationCount": 0,
                "createTime": "2023-06-28 16:23:46",
                "updateTime": "2023-06-28 16:27:49",
                "status": "Failed"
            },
            {
                "functionId": "fc-**hl",
                "functionName": "my-function-**4",
                "serviceName": "mytest6",
                "serviceId": "sv-**ir",
                "checkSum": "2f49629d0d19e7ba370bdca6dfd7d86dadc81a0958b2e71e6a5ae1867e845797",
                "codeSize": 189,
                "description": "My function description",
                "envs": [
                    {
                        "name": "--FC_FUNCTION_VERSION",
                        "value": "my-value"
                    }
                ],
                "timeout": 900,
                "handler": "index.handler",
                "runtime": "nodejs16",
                "cpu": 1,
                "memorySize": 4096,
                "diskSize": 512,
                "invocationCount": 0,
                "createTime": "2023-06-28 16:18:48",
                "updateTime": "2023-06-28 16:18:49",
                "status": "Active"
            }
        ],
        "totalCount": 4
    }
}

返回码

HTTP状态码	错误码	描述
200		OK
400	NOT_FOUND	批量查询条件仅支持name
404	NOT_FOUND	未找到服务
404	NOT_FOUND	未找到函数调用次数
404	NOT_FOUND	未找到函数
500	INTERNAL	系统错误