CreateService - Function Compute - Alibaba Cloud Documentation Center

Create a service.

Operation Description

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /2021-04-06/services

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The definition of the service.
description	string	No	The description of the service.	service_description
internetAccess	boolean	No	Specifies whether to allow functions to access the Internet. Valid values: true: allows functions to access the Internet. This is the default value. false: does not allow functions to access the Internet.	true
logConfig	LogConfig	No	The log configuration. Function Compute writes function execution logs to the specified Logstore.
nasConfig	NASConfig	No	The configuration of the Apsara File Storage NAS (NAS) file system. The configurations allow functions in the specified service to access the NAS file system.
role	string	No	The RAM role that is used to grant required permissions to Function Compute. The RAM role is used in the following scenarios: Sends function execution logs to your Logstore. Generates a token for a function to access other cloud resources during function execution.	acs:ram::188077086902****:role/fc-test
serviceName	string	Yes	The name of the service. The name can contain only letters, digits, hyphens (-), and underscores (_). It cannot start with a digit or hyphen (-). It must be 1 to 128 characters in length.	service_Name
vpcConfig	VPCConfig	No	The VPC configurations. The configurations allow functions in the specified service to access the specified VPC.
tracingConfig	TracingConfig	No	The configuration of Tracing Analysis. After Function Compute is integrated with Tracing Analysis, you can record the duration of a request in Function Compute, view the cold start time of a function, and record the execution duration of a function. For more information, see Tracing Analysis.
ossMountConfig	OSSMountConfig	No	The OSS mount configurations.
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	The time on which the function is invoked. The format of the value is: EEE,d MMM yyyy HH:mm:ss GMT.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	The custom request ID.	asdf****

Response parameters

Parameter	Type	Description	Example
headers	object
etag	string	The ETag that is used to modify the service This value is used to ensure that the modified service is consistent with the service to be modified.	5e547e5605e1dc17a78a6191bc18fbc5
	object	The returned data.
createdTime	string	The time when the service was created.	2016-08-15T16:06:05.000+0000
description	string	The description of the service.	service_description
internetAccess	boolean	Specifies whether to allow functions to access the Internet. Valid values: true: allows functions in the specified service to access the Internet. false: does not allow functions in the specified service to access the Internet.	true
lastModifiedTime	string	The time when the service was last modified.	2016-08-15T16:06:05.000+0000
logConfig	LogConfig	The log configuration. Function Compute writes function execution logs to the specified Logstore.
nasConfig	NASConfig	The configuration of the NAS file system. The configurations allow functions in the specified service to access the NAS file system.
role	string	The RAM role that is used to grant required permissions to Function Compute. The RAM role is used in the following scenarios: Sends function execution logs to your Logstore. Generates a token for a function to access other cloud resources during function execution.	acs:ram::188077086902****:role/fc-test
serviceId	string	The unique ID generated by the system for the service.	2d28e0e9-9ba5-4eed-8b1a-d3d9cd24e737
serviceName	string	The name of the service.	service_Name
vpcConfig	VPCConfig	The VPC configurations. The configurations allow functions in the specified service to access the specified VPC.
tracingConfig	TracingConfig	The configuration of Tracing Analysis. After Function Compute is integrated with Tracing Analysis, you can record the duration of a request in Function Compute, view the cold start time of a function, and record the execution duration of a function. For more information, see Tracing Analysis.
ossMountConfig	OSSMountConfig	The OSS mount configurations.

Examples

Sample success responses

JSONformat

{
  "createdTime": "2016-08-15T16:06:05.000+0000",
  "description": "service_description",
  "internetAccess": true,
  "lastModifiedTime": "2016-08-15T16:06:05.000+0000",
  "logConfig": {
    "logstore": "test-prj",
    "project": "test-logstore",
    "enableRequestMetrics": true,
    "enableInstanceMetrics": true,
    "logBeginRule": "DefaultRegex"
  },
  "nasConfig": {
    "groupId": 100,
    "mountPoints": [
      {
        "mountDir": "/home/test",
        "serverAddr": "***-uni85.cn-hangzhou.nas.aliyuncs.com:/",
        "enableTLS": false
      }
    ],
    "userId": 100
  },
  "role": "acs:ram::188077086902****:role/fc-test",
  "serviceId": "2d28e0e9-9ba5-4eed-8b1a-d3d9cd24e737",
  "serviceName": "service_Name",
  "vpcConfig": {
    "securityGroupId": "sg-bp18hj1wtxgy3b0***",
    "vSwitchIds": [
      "vsw-bp1ozpcrdc6r****"
    ],
    "vpcId": "vpc-***",
    "role": "acs:ram::1234567890:role/fc-test"
  },
  "tracingConfig": {
    "type": "Jaeger",
    "params": {
      "key": "{\"endpoint\": \"tracing_analysis_jaeger_endpoint\"}"
    }
  },
  "ossMountConfig": {
    "mountPoints": [
      {
        "bucketName": "my-bucket",
        "mountDir": "/mnt/dir",
        "readOnly": true,
        "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
        "bucketPath": "/my-dir"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2021-06-29