HTTP domain name-related information
Used by actions: GetFunction.
| Name | Type | Required | Description |
|---|---|---|---|
| Host | String | Yes | Domain name |
| Vip | String | Yes | VIP |
Version alias of function
Used by actions: ListAliases.
| Name | Type | Required | Description |
|---|---|---|---|
| FunctionVersion | String | Yes | Master version pointed to by the alias |
| Name | String | Yes | Alias name |
| RoutingConfig | RoutingConfig | Yes | Routing information of alias Note: this field may return null, indicating that no valid values can be obtained. |
| Description | String | No | Description Note: this field may return null, indicating that no valid values can be obtained. |
| AddTime | Timestamp | No | Creation time Note: this field may return null, indicating that no valid values can be obtained. |
| ModTime | Timestamp | No | Update time Note: this field may return null, indicating that no valid values can be obtained. |
File system (CFS) configuration description
Used by actions: CreateFunction, GetFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| CfsInsList | Array of CfsInsInfo | Yes | File system information list |
Configuration information of the CFS instance associated with function
Used by actions: CreateFunction, GetFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| UserId | String | Yes | User ID |
| UserGroupId | String | Yes | User group ID |
| CfsId | String | Yes | CFS instance ID |
| MountInsId | String | Yes | File system mount target ID |
| LocalMountDir | String | Yes | Local mount target |
| RemoteMountDir | String | Yes | Remote mount target |
| IpAddress | String | No | File system IP, which is not required when you configure CFS. Note: this field may return null, indicating that no valid values can be obtained. |
| MountVpcId | String | No | VPC ID of file system, which is not required when you configure CFS. Note: this field may return null, indicating that no valid values can be obtained. |
| MountSubnetId | String | No | VPC subnet ID of file system, which is not required when you configure CFS. Note: this field may return null, indicating that no valid values can be obtained. |
Function code
Used by actions: CreateFunction, PublishLayerVersion, UpdateFunctionCode.
| Name | Type | Required | Description |
|---|---|---|---|
| CosBucketName | String | No | COS bucket name |
| CosObjectName | String | No | COS object path |
| ZipFile | String | No | It contains a function code file and its dependencies in the ZIP format. When you use this API, the ZIP file needs to be encoded with Base64. Up to 20 MB is supported. |
| CosBucketRegion | String | No | COS region. For Beijing regions, you need to import ap-beijing. For Beijing Region 1, you need to input ap-beijing-1. For other regions, no import is required. |
| DemoId | String | No | DemoId is required if Demo is used for the creation. |
| TempCosObjectName | String | No | TempCosObjectName is required if TempCos is used for the creation. |
| GitUrl | String | No | Git address |
| GitUserName | String | No | Git user name |
| GitPassword | String | No | Git password |
| GitPasswordSecret | String | No | Git password after encryption. In general, this value is not required. |
| GitBranch | String | No | Git branch |
| GitDirectory | String | No | Code path in Git repository |
| GitCommitId | String | No | Version to be pulled |
| GitUserNameSecret | String | No | Git user name after encryption. In general, this value is not required. |
Dead letter queue parameter
Used by actions: CreateFunction, GetFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Dead letter queue mode |
| Name | String | Yes | Dead letter queue name |
| FilterType | String | No | Tag form of a dead letter queue topic mode |
Fixed IP configuration for public network access
Used by actions: CreateFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| EipStatus | String | Yes | Status of the EIP. Values: ['ENABLE','DISABLE'] |
Fixed IP configuration for public network access
Used by actions: GetFunction.
| Name | Type | Description |
|---|---|---|
| EipStatus | String | Whether it is a fixed IP. Valid values: ["ENABLE","DISABLE"] |
| EipAddress | Array of String | IP list Note: This field may return null, indicating that no valid values can be obtained. |
EipOutConfig
Used by actions: GetFunction.
| Name | Type | Description |
|---|---|---|
| EipFixed | String | It specifies whether the IP is fixed. The value is TRUE or FALSE. |
| Eips | Array of String | IP list |
Environment variable parameter of the function
Used by actions: CreateFunction, GetFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| Variables | Array of Variable | No | Environment variable array |
Key-value pair filters for conditional filtering queries, such as filtering ID, name, and status.
If more than one filter exists, the logical relationship between these filters is AND.
If multiple values exist in one filter, the logical relationship between these values under the same filter is OR.
Used by actions: ListFunctions, ListTriggers.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Fields to be filtered |
| Values | Array of String | Yes | Filter values of the field |
Function list
Used by actions: ListFunctions.
| Name | Type | Description |
|---|---|---|
| ModTime | String | Modification time |
| AddTime | String | Creation time |
| Runtime | String | Running |
| FunctionName | String | Function name |
| FunctionId | String | Function ID |
| Namespace | String | Namespace |
| Status | String | Function status. For valid values and status change process, please see here |
| StatusDesc | String | Function status details |
| Description | String | Function description |
| Tags | Array of Tag | Function tag |
| Type | String | Function type. The value is HTTP or Event. |
| StatusReasons | Array of StatusReason | Cause of function failure |
| TotalProvisionedConcurrencyMem | Integer | Sum of provisioned concurrence memory for all function versions Note: this field may return null, indicating that no valid values can be obtained. |
| ReservedConcurrencyMem | Integer | Reserved memory for function concurrence Note: this field may return null, indicating that no valid values can be obtained. |
Log information
Used by actions: GetFunctionLogs.
| Name | Type | Description |
|---|---|---|
| FunctionName | String | Function name |
| RetMsg | String | Return value after the function is executed |
| RequestId | String | RequestId corresponding to the executed function |
| StartTime | Timestamp | Start time of the function execution |
| RetCode | Integer | Function execution result. 0 indicates successful execution and other values indicate failure. |
| InvokeFinished | Integer | It specifies whether the function invocation is finished. 1 indicates execution completion and other values indicate that exceptions occurred during the invocation. |
| Duration | Float | Duration of the function execution. The unit is millisecond (ms). |
| BillDuration | Integer | Function billing duration. The unit is millisecond (ms). The value is rounded up to a multiple of 100 ms. |
| MemUsage | Integer | Actual memory size used during the function execution. The unit is byte. |
| Log | String | Function execution logs |
| Level | String | Log level |
| Source | String | Log source |
| RetryNum | Integer | Number of retries |
Function version information
Used by actions: ListVersionByFunction.
| Name | Type | Required | Description |
|---|---|---|---|
| Version | String | Yes | Function version name |
| Description | String | No | Version description Note: This field may return null, indicating that no valid values is found. |
| AddTime | Timestamp | No | The creation time Note: This field may return null, indicating that no valid value was found. |
| ModTime | Timestamp | No | Update time Note: This field may return null, indicating that no valid value was found. |
Layer version information
Used by actions: GetFunction, ListLayerVersions, ListLayers.
| Name | Type | Description |
|---|---|---|
| CompatibleRuntimes | Array of String | Runtime applicable to a version Note: This field may return null, indicating that no valid values can be obtained. |
| AddTime | String | Creation time |
| Description | String | Version description Note: This field may return null, indicating that no valid values can be obtained. |
| LicenseInfo | String | License information Note: This field may return null, indicating that no valid values can be obtained. |
| LayerVersion | Integer | Version number |
| LayerName | String | Layer name |
| Status | String | Current status of specific layer version. For valid values, please see here |
Specifies a layer version
Used by actions: CreateFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| LayerName | String | Yes | Layer name |
| LayerVersion | Integer | Yes | Version number |
Log filtering criteria, which is for distinguishing between logs of successful and failed execution
Used by actions: GetFunctionLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| RetCode | String | No | Values of filter.RetCode include:not0, indicating that only logs of failed execution will be returned. is0, indicating that only logs of successful execution will be returned. TimeLimitExceeded, indicating that logs of function invocations which timed out will be returned. ResourceLimitExceeded, indicating that logs of function invocations during which resources exceeded the upper limit will be returned. UserCodeException, indicating that logs of function invocations during which a user code error occurred will be returned. Blank, indicating that all logs will be returned. |
Log search context
Used by actions: GetFunctionLogs.
| Name | Type | Required | Description |
|---|---|---|---|
| Offset | String | Yes | Offset. |
| Limit | Integer | Yes | Log record number |
| Keyword | String | No | Log keyword |
| Type | String | No | Log type. The value is Application (default) or Platform. |
Namespace
Used by actions: ListNamespaces.
| Name | Type | Description |
|---|---|---|
| ModTime | Timestamp | Creation time of the namespace |
| AddTime | Timestamp | Modification time of the namespace |
| Description | String | Namespace description |
| Name | String | Namespace name |
| Type | String | The default value is default. TCB indicates that the namespace is developed and created through the mini-program cloud. |
Public network access configuration
Used by actions: CreateFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| PublicNetStatus | String | Yes | Whether to enable public network access. Valid values: ['DISABLE', 'ENABLE'] |
| EipConfig | EipConfigIn | No | EIP configuration |
Public network access configuration
Used by actions: GetFunction.
| Name | Type | Description |
|---|---|---|
| PublicNetStatus | String | Whether to enable public network access. Valid values: ['DISABLE', 'ENABLE'] |
| EipConfig | EipConfigOut | EIP configuration |
Response of the executed function
Used by actions: Invoke.
| Name | Type | Description |
|---|---|---|
| Log | String | It indicates the log output during the function execution. Null is returned for asynchronous invocations. |
| RetMsg | String | It indicates the response from the executed function. Null is returned for asynchronous invocations. |
| ErrMsg | String | It indicates the error message of the executed function. Null is returned for asynchronous invocations. |
| MemUsage | Integer | It indicates the memory size (in bytes) when the function is running. Null is returned for asynchronous invocations. |
| Duration | Float | It indicates the duration (in milliseconds) required for running the function. Null is returned for asynchronous invocations. |
| BillDuration | Integer | It indicates the billing duration (in milliseconds) for the function. Null is returned for asynchronous invocations. |
| FunctionRequestId | String | ID of the executed function |
| InvokeResult | Integer | 0 indicates successful execution. Null is returned for asynchronous invocations. |
Version routing configuration of alias
Used by actions: CreateAlias, GetAlias, ListAliases, UpdateAlias.
| Name | Type | Required | Description |
|---|---|---|---|
| AdditionalVersionWeights | Array of VersionWeight | No | Additional version with random weight-based routing |
| AddtionVersionMatchs | Array of VersionMatch | No | Additional version with rule-based routing |
State reason description
Used by actions: GetFunction, ListFunctions.
| Name | Type | Description |
|---|---|---|
| ErrorCode | String | Error code |
| ErrorMessage | String | Error message |
Function tag
Used by actions: CreateFunction, GetFunction, ListFunctions.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Tag key |
| Value | String | Yes | Tag value |
Trigger type
Used by actions: CreateTrigger, GetFunction.
| Name | Type | Description |
|---|---|---|
| ModTime | Timestamp | Latest modification time of the trigger |
| Type | String | Trigger type |
| TriggerDesc | String | Detailed trigger configuration |
| TriggerName | String | Trigger name |
| AddTime | Timestamp | Creation time of the trigger |
| Enable | Integer | Enabling switch |
| CustomArgument | String | Custom parameter |
| AvailableStatus | String | Trigger status |
| ResourceId | String | Minimum resource ID of trigger |
| BindStatus | String | Trigger-Function binding status |
| TriggerAttribute | String | Trigger type. Two-way means that the trigger can be manipulated in both consoles, while one-way means that the trigger can be created only in the SCF Console |
| Qualifier | String | The alias or version bound with the trigger |
Trigger information
Used by actions: ListTriggers.
| Name | Type | Description |
|---|---|---|
| Enable | Integer | Whether to enable |
| Qualifier | String | Function version or alias |
| TriggerName | String | Trigger name |
| Type | String | Trigger type |
| TriggerDesc | String | Detailed configuration of trigger |
| AvailableStatus | String | Whether the trigger is available |
| CustomArgument | String | Custom parameter Note: this field may return null, indicating that no valid values can be obtained. |
| AddTime | Timestamp | Trigger creation time |
| ModTime | Timestamp | Trigger last modified time |
| ResourceId | String | Minimum resource ID of trigger |
| BindStatus | String | Trigger-Function binding status |
| TriggerAttribute | String | Trigger type. Two-way means that the trigger can be manipulated in both consoles, while one-way means that the trigger can be created only in the SCF Console |
Variable parameter
Used by actions: CreateFunction, GetFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Variable name |
| Value | String | No | Variable value |
Function version with match rule
Used by actions: CreateAlias, GetAlias, ListAliases, UpdateAlias.
| Name | Type | Required | Description |
|---|---|---|---|
| Version | String | Yes | Function version name |
| Key | String | Yes | Matching rule key. When the API is called, pass in the key to route the request to the specified version based on the matching ruleHeader method: Enter "invoke.headers.User" for key and pass in RoutingKey:{"User":"value"} when invoking a function through invoke for invocation based on rule matching |
| Method | String | Yes | Match method. Valid values: range: range match exact: exact string match |
| Expression | String | Yes | Rule requirements for range match: It should be described in an open or closed range, i.e., (a,b) or [a,b], where both a and b are integersRule requirements for exact match: Exact string match |
Provisioned concurrency information of function version, including the set provisioned concurrency amount, available provisioned concurrency amount, and provisioned concurrency setting task status.
Used by actions: GetProvisionedConcurrencyConfig.
| Name | Type | Description |
|---|---|---|
| AllocatedProvisionedConcurrencyNum | Integer | Set provisioned concurrency amount. |
| AvailableProvisionedConcurrencyNum | Integer | Currently available provisioned concurrency amount. |
| Status | String | Provisioned concurrency setting task status. Done: completed; InProgress: in progress; Failed: partially or completely failed. |
| StatusReason | String | Status description of provisioned concurrency setting task. |
| Qualifier | String | Function version number |
Function version with weight
Used by actions: CreateAlias, GetAlias, ListAliases, UpdateAlias.
| Name | Type | Required | Description |
|---|---|---|---|
| Version | String | Yes | Function version name |
| Weight | Float | Yes | Version weight |
VPC parameter configuration
Used by actions: CreateFunction, GetFunction, UpdateFunctionConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| VpcId | String | No | VPC ID |
| SubnetId | String | No | Subnet ID |
Was this page helpful?