获取指定函数的版本列表
功能介绍
获取指定函数的版本列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/fgs/functions/{function_urn}/versions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户项目 ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
function_urn |
是 |
String |
参数解释: 函数的URN,详细解释见FunctionGraph函数模型的描述。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字、下划线、中划线、冒号组成。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
参数解释: 上一次查询到的最后的记录位置。 约束限制: 不涉及。 取值范围: 只能取大于等于0的整数。 默认取值: 0 |
maxitems |
否 |
String |
参数解释: 上一次查询到的最后的记录位置。 约束限制: 不涉及。 取值范围: 只能取大于等于0的整数。 默认取值: 0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 只能为application/json。 默认取值: application/json |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
versions |
Array of ListFunctionVersionResult objects |
参数解释: 版本列表。 取值范围: 不涉及。 |
next_marker |
Long |
参数解释: 下一次记录位置。 取值范围: 不涉及。 |
count |
Long |
参数解释: 版本总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
func_urn |
String |
参数解释: 函数的URN(Uniform Resource Name),唯一标识函数。 取值范围: 不涉及。 |
func_name |
String |
参数解释: 函数名称。 取值范围: 不涉及。 |
domain_id |
String |
参数解释: 租户账号id。 取值范围: 不涉及。 |
namespace |
String |
参数解释: 租户的project id。 取值范围: 不涉及。 |
project_name |
String |
参数解释: 租户的project name。 取值范围: 不涉及。 |
package |
String |
参数解释 函数所属的分组Package,用于用户针对函数的自定义分组。 取值范围 不涉及。 |
runtime |
String |
参数解释: FunctionGraph函数的运行时,即函数执行环境。 取值范围: |
timeout |
Integer |
参数解释: 函数执行超时时间,超时函数将被强行停止。 取值范围: 3~259200秒 |
handler |
String |
参数解释: 函数执行入口 规则:xx.xx,必须包含“. ”;自定义镜像函数handler为“-”。 举例:对于node.js函数:myfunction.handler,则表示函数的文件名为myfunction.js,执行的入口函数名为handler。长度不超过128个字符。 取值范围: 最小长度为3,最大长度128字符。 |
memory_size |
Integer |
参数解释: 函数消耗的内存,单位MB。 取值范围: |
cpu |
Integer |
参数解释: 函数消耗的显存,只支持自定义运行时与自定义镜像函数配置GPU。 单位MB。 取值范围: 最小值为1024,最大值为16384。 |
code_type |
String |
参数解释: 函数代码类型 取值范围: 取值有5种。 |
code_url |
String |
参数解释: 当CodeType为obs时,该值为函数代码包在OBS上的地址,CodeType为其他值时,该字段为空。 取值范围: obs链接地址 |
code_filename |
String |
参数解释: 函数的文件名,当CodeType为jar/zip时必须提供该字段,inline和obs不需要提供。 取值范围: 不涉及。 |
code_size |
Long |
参数解释: 函数大小,单位:字节。 取值范围: 不涉及。 |
user_data |
String |
参数解释: 用户自定义的name/value信息。 在函数中使用的参数。 举例:如函数要访问某个主机,可以设置自定义参数:Host={host_ip},总长度不超过4KB。 取值范围: json格式的字符串 |
encrypted_user_data |
String |
参数解释: 用户自定义的name/value信息,用于需要加密的配置。 取值范围: json格式的字符串。 |
digest |
String |
参数解释: 函数代码SHA512 hash值,用于判断函数是否变化。 取值范围: 不涉及。 |
version |
String |
参数解释: 函数版本号,由系统自动生成,规则:vYYYYMMDD-HHMMSS(v+年月日-时分秒)。 取值范围: 不涉及。 |
image_name |
String |
参数解释: 函数版本号,由系统自动生成,规则:vYYYYMMDD-HHMMSS(v+年月日-时分秒)。 取值范围: 不涉及。 |
xrole |
String |
参数解释: 函数版本号,由系统自动生成,规则:vYYYYMMDD-HHMMSS(v+年月日-时分秒)。 取值范围: 不涉及。 |
app_xrole |
String |
参数解释: 函数执行委托。可为函数执行单独配置执行委托,这将减小不必要的性能损耗;不单独配置执行委托时,函数执行和函数配置将使用同一委托。 取值范围: 不涉及。 |
last_modified |
String |
参数解释: 函数执行委托。可为函数执行单独配置执行委托,这将减小不必要的性能损耗;不单独配置执行委托时,函数执行和函数配置将使用同一委托。 取值范围: 不涉及。 |
func_vpc_id |
String |
参数解释: 用户的vpcid 取值范围: 不涉及。 |
concurrency |
Integer |
参数解释: 单函数最大实例数 取值范围: v1取值0和-1,v2取值-1到1000 |
concurrent_num |
Integer |
参数解释: 单实例并发数 取值范围: v2版本才支持,取值1到1000 |
strategy_config |
StrategyConfig object |
参数解释: 函数策略配置。 取值范围: 不涉及。 |
status |
Integer |
参数解释: 函数状态。 取值范围: |
initializer_handler |
String |
参数解释: 函数初始化入口,规则:xx.xx,必须包含“. ”。当配置初始化函数时,此参数必填。 举例:对于node.js函数:myfunction.initializer,则表示函数的文件名为myfunction.js,初始化的入 口函数名为initializer。 取值范围: 不涉及。 |
initializer_timeout |
Integer |
参数解释: 初始化超时时间,超时函数将被强行停止。当配置初始化函数时,此参数必填。 取值范围: 1-300秒 |
pre_stop_handler |
String |
参数解释: 函数预停止函数的入口,规则:xx.xx,必须包含“. ”。 举例:对于node.js函数:myfunction.pre_stop_handler,则表示函数的文件名为myfunction.js,初始化的入口函数名为pre_stop_handler。 取值范围: 不涉及。 |
pre_stop_timeout |
Integer |
参数解释: 初始化超时时间,超时函数将被强行停止。 取值范围: 1~90秒 |
long_time |
Boolean |
参数解释: 是否允许进行长时间超时设置。 取值范围: |
function_async_config |
FunctionAsyncConfig object |
参数解释: 函数异步配置返回结构体。 取值范围: 不涉及。 |
type |
String |
参数解释: 函数版本。 取值范围: |
enable_dynamic_memory |
Boolean |
参数解释: 是否启用动态内存功能。 取值范围: |
enterprise_project_id |
String |
参数解释: 企业项目ID,在企业用户创建函数时必填。 取值范围: 不涉及。 |
is_stateful_function |
Boolean |
参数解释: 是否支持有状态,v2版本支持。 取值范围: |
enable_auth_in_header |
Boolean |
参数解释: 是否允许在请求头中添加鉴权信息。 取值范围: |
custom_image |
CustomImage object |
参数解释: 用户容器镜像。 取值范围: 不涉及。 |
reserved_instance_idle_mode |
Boolean |
参数解释: 是否开启预留实例闲置模式。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
concurrency |
Integer |
参数解释: 单函数最大实例数,-1代表该函数实例数无限制。 取值范围: |
concurrent_num |
Integer |
参数解释: 单实例并发数, v2版本支持。 取值范围: [1, 1000] |
参数 |
参数类型 |
描述 |
---|---|---|
max_async_event_age_in_seconds |
Integer |
参数解释: 消息最大存活时长。 取值范围: 取值范围[60,86400]。单位:秒。 |
max_async_retry_attempts |
Integer |
参数解释: 异步调用失败后的最大重试次数,默认值为3。 取值范围: 取值范围[0,8]。 |
destination_config |
FuncAsyncDestinationConfig object |
参数解释: 异步调用目标。 取值范围: 不涉及。 |
created_time |
String |
参数解释: 异步调用配置的创建时间。 取值范围: 不涉及。 |
last_modified |
String |
参数解释: 异步调用配置的最后更改时间。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
on_success |
FuncDestinationConfig object |
参数解释: 当函数执行成功时,函数计算将调用该配置对应的目标。 取值范围: 不涉及。 |
on_failure |
FuncDestinationConfig object |
参数解释: 当函数执行失败(系统错误或函数内部错误)时,函数计算将调用该配置对应的目标。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
destination |
String |
参数解释: 目标类型。 取值范围: |
param |
String |
参数解释: 通知目标服务对应参数,json字符串。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
enabled |
Boolean |
参数解释: 是否使用镜像。不使用镜像则以下参数不生效。 取值范围: |
image |
String |
参数解释: 镜像地址。 取值范围: 不涉及。 |
command |
String |
参数解释: 启动容器镜像的命令。 取值范围: 不涉及。 |
args |
String |
参数解释: 启动容器镜像的命令行参数。 取值范围: 不涉及。 |
working_dir |
String |
参数解释: 镜像容器工作目录。 取值范围: 不涉及。 |
uid |
String |
参数解释: 镜像容器的用户id。 取值范围: 不涉及。 |
gid |
String |
参数解释: 镜像容器的用户组id。 取值范围: 不涉及。 |
is_public |
Boolean |
参数解释: 是否是公共镜像。 取值范围:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询函数列表。
GET https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/versions
响应示例
状态码: 200
OK
{ "versions" : [ { "func_urn" : "urn:fss:xxxxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test", "func_name" : "test", "domain_id" : "14ee2e3501124efcbca7998baa24xxxx", "namespace" : "46b6f338fc3445b8846c71dfb1fbxxxx", "project_name" : "xxxxx", "package" : "default", "runtime" : "Node.js6.10", "timeout" : 3, "handler" : "test.handler", "memory_size" : 128, "cpu" : 300, "code_type" : "inline", "code_filename" : "index.js", "code_size" : 272, "digest" : "faa825575c45437cddd4e369bea69893bcbe195d478178462ad90984fe72993f3f59d15f41c5373f807f3e05fb9af322c55dabeb16565c386e402413458e6068", "version" : "latest", "image_name" : "latest-191025153727@zehht", "last_modified" : "2019-10-25 15:37:27", "strategy_config" : { "concurrency" : 0 } } ], "next_marker" : 5 }
状态码: 404
Not Found 找不到资源。
{ "error_code" : "FSS.1051", "error_msg" : "Not found the function" }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion; import com.huaweicloud.sdk.functiongraph.v2.*; import com.huaweicloud.sdk.functiongraph.v2.model.*; public class ListFunctionVersionsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); FunctionGraphClient client = FunctionGraphClient.newBuilder() .withCredential(auth) .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>")) .build(); ListFunctionVersionsRequest request = new ListFunctionVersionsRequest(); request.withMarker("<marker>"); request.withMaxitems("<maxitems>"); try { ListFunctionVersionsResponse response = client.listFunctionVersions(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkfunctiongraph.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = FunctionGraphClient.new_builder() \ .with_credentials(credentials) \ .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFunctionVersionsRequest() request.marker = "<marker>" request.maxitems = "<maxitems>" response = client.list_function_versions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := functiongraph.NewFunctionGraphClient( functiongraph.FunctionGraphClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFunctionVersionsRequest{} markerRequest:= "<marker>" request.Marker = &markerRequest maxitemsRequest:= "<maxitems>" request.Maxitems = &maxitemsRequest response, err := client.ListFunctionVersions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request 请求错误。 |
401 |
Unauthorized 鉴权失败。 |
403 |
Forbidden 没有操作权限。 |
404 |
Not Found 找不到资源。 |
500 |
Internal Server Error 服务内部错误。 |
错误码
请参见错误码。