当前位置:首页 > 行业动态 > 正文

函数计算FC有没有详细点的绘图的api接口参数说明文档?那些参数很多都不知道是什么意思

函数计算FC(Function Compute)是阿里云提供的一种事件驱动的全托管计算服务,它可以帮助用户在无需管理服务器的情况下,快速构建并运行应用程序,为了帮助用户更好地理解和使用函数计算FC,本文将详细介绍其绘图API接口参数说明文档,以及这些参数的含义和作用。

1、创建函数

在使用函数计算FC进行绘图之前,首先需要创建一个函数,创建函数时,需要提供以下参数:

参数名称 类型 是否必填 描述
函数名称 String 函数的名称,用于标识函数。
运行时版本 String 函数使用的运行时版本。
内存大小 String 函数的内存大小,单位为MB。
超时时间 String 函数的超时时间,单位为秒。
代码包 Object 包含函数代码的文件列表。
环境变量 Object 函数的环境变量。
VPC配置 Object 函数的VPC配置。
自定义域名 String 函数的自定义域名。
角色授权策略ARN String 函数的角色授权策略ARN。
标签 Object 函数的标签。

2、触发器配置

创建函数后,需要为其配置触发器,以便在特定事件发生时自动执行函数,触发器配置包括以下参数:

参数名称 类型 是否必填 描述
触发器名称 String 触发器的名称,用于标识触发器。
触发器类型 String 触发器的类型,如HTTP、OSS等。
触发器表达式 String 触发器的表达式,用于描述触发条件。
并发执行限制 Integer 触发器的最大并发执行次数,默认值为100。
Webhook配置 Object Webhook的配置信息,仅当触发器类型为HTTP时有效。

3、API调用参数

通过API调用函数计算FC进行绘图时,需要提供以下参数:

参数名称 类型 是否必填 描述
FunctionName String 要调用的函数名称。
InvocationType String API调用类型,如Event、Procedure等。
LogType String API调用的日志级别,如DEBUG、INFO等,默认值为INFO。
PayloadFormatVersion String API调用的有效载荷格式版本,默认值为1.0。

| PayloadTruncated | String | 否 | API调用的有效载荷是否被截断,默认值为False,如果为True,则表示有效载荷被截断。

ClientContext String API调用的客户端上下文,默认值为空字符串,如果提供了ClientContext,则必须提供InvokeIdentity、Signer和Token参数。
SignerType String API调用的签名类型,如HMACSHA1、HMACSHA256等,默认值为HMACSHA1。
SignedHeaders List API调用的签名头列表,默认值为空列表,如果提供了SignedHeaders,则必须提供Signer和Token参数。
EncodedPayloadData String/Blob/Stream/ByteArray/File/Base64EncodedString/ArrayBuffer/Document/XMLNodeList/JSONNodeList/QueryMap/FormDataObject/MultipartFormDataObject/URLSearchParams/TextNodeList/CanonicalizedHeaderSet/CanonicalizedResourceList/CanonicalizedQueryStringParameters/CanonicalizedHeadersList/CanonicalizedResourceListWithQueryStringParameters/CanonicalizedResourceListWithQueryStringParametersAndHeadersList/CanonicalizedResourceListWithQueryStringParametersAndHeadersListAndPathsList/CanonicalizedResourceListWithQueryStringParametersAndHeadersListAndPathsListAndQueryStringParametersList/CanonicalizedResourceListWithQueryStringParametersAndHeadersListAndPathsListAndQueryStringParametersListAndHeadersList API调用的有效载荷数据,默认值为空字符串,如果提供了EncodedPayloadData,则必须提供Signer和Token参数。
Qualifier API调用的限定符,默认值为空字符串,如果提供了Qualifier,则必须提供InvokeIdentity、Signer和Token参数。
AccessKeyId API调用的AccessKeyId,默认值为空字符串,如果提供了AccessKeyId,则必须提供Signer和Token参数。
AccessKeySecret API调用的AccessKeySecret,默认值为空字符串,如果提供了AccessKeySecret,则必须提供Signer和Token参数。
SecurityToken API调用的安全令牌,默认值为空字符串,如果提供了SecurityToken,则必须提供Signer和Token参数。
RequestPayload API调用的请求有效载荷,默认值为空字符串,如果提供了RequestPayload,则必须提供Signer和Token参数。
X509Certificate API调用的X509证书,默认值为空字符串,如果提供了X509Certificate,则必须提供Signer和Token参数。
ClientToken API调用的客户端令牌,默认值为空字符串,如果提供了ClientToken,则必须提供Signer和Token参数。
Expires API调用的过期时间戳(Unix时间戳),默认值为空字符串,如果提供了Expires,则必须提供Signer和Token参数。
DeadlineSeconds API调用的截止时间(秒),默认值为空字符串,如果提供了DeadlineSeconds,则必须提供Signer和Token参数。
ReadOnly API调用是否只读,默认值为False,如果为True,则表示只读操作;否则表示读写操作。
Force API调用是否强制执行操作(即使存在错误),默认值为False,如果为True,则表示强制执行操作;否则表示不强制执行操作(即使存在错误)。
ContentSha256 API调用的内容SHA256哈希值(Base64编码),默认值为空字符串,如果提供了ContentSha256,则必须提供Signer和Token参数。
UserAgent API调用的用户代理字符串(UserAgent),默认值为空字符串,如果提供了UserAgent,则必须提供Signer和Token参数。
RetryDelay API调用的重试延迟(秒),默认值为0秒(即立即重试),如果提供了RetryDelay,则必须提供Signer和Token参数。

4、API响应参数

API调用完成后,会返回一个响应对象,其中包含以下参数:

参数名称 类型 是否必填 描述
FunctionError API调用的错误信息(如果有的话),默认值为None,如果存在错误信息,则为ErrorMessage、StackTrace和LogTail字段组成的字典;否则为None或空字典({})。
FunctionExecutionContext API调用的执行上下文信息(如果有的话),默认值为None或空字典({}),如果存在执行上下文信息,则为ExecutionContext字段组成的字典;否则为None或空字典({})。
Payload API调用的有效载荷数据(如果有的话),默认值为None或空字符串(””),如果存在有效载荷数据,则为Payload字段;否则为None或空字符串(””),注意:Payload字段的数据类型取决于InvocationType参数的值和有效载荷数据的编码方式(如Base64编码、UTF8编码等),如果InvocationType为Event且PayloadFormatVersion为1.0,则Payload字段的数据类型为Dict[str, Any];如果InvocationType为Procedure且PayloadFormatVersion为1.0,则Payload字段的数据类型为Any;等等。

FAQs:

问题1:什么是函数计算FC?如何创建一个函数?

答案:函数计算FC是阿里云提供的一种事件驱动的全托管计算服务,可以帮助用户在无需管理服务器的情况下快速构建并运行应用程序,要创建一个函数,需要提供函数名称、运行时版本、内存大小、超时时间、代码包、环境变量、VPC配置、自定义域名、角色授权策略ARN和标签等参数。

0