All Products
Search
Document Center

General data structures

Last Updated: Jan 19, 2021

CertConfig

The configuration of the HTTPS certificate.

Parameter

Type

Example

Description

CertName

String

/login/

The name of the certificate, which can be customized.

Certificate

String

-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----

The certificate. To configure a certificate chain, you must enter multiple certificates in sequence.

PrivateKey

String

-----BEGIN RSA PRIVATE KEY----- xxxxx -----END RSA PRIVATE KEY-----

The private key.

Code

The error code.

Parameter

Type

Example

Description

ossBucketName

String

test-bucket

The name of the Object Storage Service (OSS) bucket that stores the ZIP package of the function code.

ossObjectName

String

test-object

The name of the OSS object that stores the ZIP package of the function code.

zipFile

String

samplecode

The function code that is encoded in Base64.

CustomContainerConfig

The configuration of the custom container. After you configure the custom container, you can use custom container images to execute functions.

Parameter

Type

Example

Description

args

String

["-arg1", "value1"]

The startup parameters of the container.

command

String

["/code/myserver"]

The command to be run to start the container.

image

String

registry-vpc.cn-hangzhou.aliyuncs.com/fc-demo/helloworld:v1beta1

The URL of the container image.

accelerationType

String

Default

Specifies whether to enable image pull acceleration. Valid values:

  • Default: enables image pull acceleration.
  • None: disables image pull acceleration.

Default value: None.

DestinationConfig

The configuration of the destination for asynchronous invocation.

Parameter

Type

Example

Description

onFailure

Object

The destination for a failed asynchronous invocation.

destination

String

acs:fc:cn-hangzhou:1986****43:services/service_name.alias/functions/testHelloWorld

The Alibaba Cloud Resource Name (ARN) of the destination.

onSuccess

Object

The destination for a successful asynchronous invocation.

destination

String

acs:mns:cn-shanghai:1986****43:/queues/queue_name/messages

The ARN of the destination.

Error

The error.

Parameter

Type

Example

Description

errorCode

String

InvalidArgument

The error code returned by Function Compute. For more information, see Error codes.

errorMessage

String

%s

The error message returned by Function Compute. For more information, see Error codes.

LogConfig

The log configuration. This parameter specifies a Logstore to store function execution logs.

Parameter

Type

Example

Description

logstore

String

test_logstore

The name of the Logstore in Log Service.

project

String

test_project

The name of the project in Log Service.

NASConfig

The configuration of the Apsara File Storage NAS file system. This parameter allows functions of the specified service in Function Compute to access the NAS file system.

Parameter

Type

Example

Description

groupId

String

100

The ID of the group.

mountPoints

Array

The mount targets.

mountDir

String

/home/test

The on-premises mount directory.

serverAddr

String

***-uni85.cn-hangzhou.nas.aliyuncs.com:/

The address of the NAS server.

userId

String

100

The ID of the account.

PathConfig

The single routing rule for a custom domain name.

Parameter

Type

Example

Description

FunctionName

String

function_name

The function name that corresponds to the domain name.

Methods

Array of String

GET

The request method of the domain name.

Path

String

/login/*

The request path of the domain name.

Qualifier

String

test

The version or alias of the service in Function Compute.

ServiceName

String

service_name

The name of the service where the function that corresponds to the domain name is created.

RouteConfig

The configuration of the route table. The route table maps paths to functions when the functions are invoked by using custom domain names.

Parameter

Type

Example

Description

Routes

Array of PathConfig

The array of routes.

TracingConfig

The configuration of Tracing Analysis. After you configure Tracing Analysis for a service in Function Compute, you can record the execution duration of a request, view the cold start time for a function, and record the execution duration of a function. For more information, see Overview.

Parameter

Type

Example

Description

Type

String

Jaeger

The type of the tracing system.

Params

Map

The parameters that are used in tracing.

VPCConfig

The virtual private cloud (VPC) configuration, which enables a function to access the specified VPC.

Parameter

Type

Example

Description

securityGroupId

String

sg_bp18hj1wtxgy3***

The ID of the security group.

vSwitchIds

Array of String

vsw_***

The ID of the vSwitch.

vpcId

String

vpc_***

The ID of the VPC.