All Products
Search
Document Center

Function Compute:CreateService

Last Updated:Nov 06, 2024

Create a service.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
fc:CreateServicecreate
  • Service
    acs:fc:{#regionId}:{#accountId}:services/{#serviceName}
  • fc:EnableServiceSLSLogging
  • fc:EnableServiceInternetAccess
none

Request syntax

POST /2021-04-06/services HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The definition of the service.

descriptionstringNo

The description of the service.

service_description
internetAccessbooleanNo

Specifies whether to allow functions to access the Internet. Default value: true. Valid values:

  • true
  • false
true
logConfigLogConfigNo

The log configurations. Function Compute writes function execution logs to the specified Logstore.

nasConfigNASConfigNo

The File Storage NAS (NAS) configurations. The configurations allow functions to access the specified NAS file system.

rolestringNo

The Alibaba Cloud Resource Name (ARN) of the RAM role that is used to grant required permissions to Function Compute. The RAM role is used in the following scenarios:

  • Send function execution logs to your Logstore.
  • Generate a token for a function to access other cloud resources during function executions.
acs:ram::188077086902****:role/fc-test
serviceNamestringYes

The name of the service. The name can contain only letters, digits, hyphens (-), and underscores (_). It cannot start with a digit or hyphen (-). The name must be 1 to 128 characters in length.

service_Name
vpcConfigVPCConfigNo

The Virtual Private Cloud (VPC) configurations. The configurations allow the function to access the specified VPCs.

tracingConfigTracingConfigNo

The configuration of Managed Service for OpenTelemetry. After Function Compute is integrated with Managed Service for OpenTelemetry, you can record the duration of a request in Function Compute, view the cold start duration of a function, and record the execution duration of a function. For more information, see Tracing analysis.

ossMountConfigOSSMountConfigNo

The Object Storage Service (OSS) mounting configurations.

X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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-IdstringNo

The custom request ID.

asdf****

Response parameters

ParameterTypeDescriptionExample
headersobject
etagstring

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.

createdTimestring

The time when the service was created.

2016-08-15T16:06:05.000+0000
descriptionstring

The description of the service.

service_description
internetAccessboolean

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
lastModifiedTimestring

The time when the service was last modified.

2016-08-15T16:06:05.000+0000
logConfigLogConfig

The log configurations. Function Compute writes function execution logs to the specified Logstore.

nasConfigNASConfig

The NAS configurations. The configurations allow functions to access the specified NAS file system.

rolestring

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
serviceIdstring

The unique ID generated by the system for the service.

2d28e0e9-9ba5-4eed-8b1a-d3d9cd24e737
serviceNamestring

The name of the service.

service_Name
vpcConfigVPCConfig

The VPC configurations. The configurations allow the function to access the specified VPCs.

tracingConfigTracingConfig

The configuration of Managed Service for OpenTelemetry. After Function Compute is integrated with Managed Service for OpenTelemetry, you can record the duration of a request in Function Compute, view the cold start duration of a function, and record the execution duration of a function. For more information, see Tracing analysis.

ossMountConfigOSSMountConfig

The OSS mounting configurations.

useSLRAuthenticationboolean

Indicates whether service-linked role authorization is enabled. Valid values:

  • true
  • false
true

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": ""
  },
  "tracingConfig": {
    "type": "Jaeger",
    "params": {
      "key": "http://tracing-analysis-dc-hz.aliyuncs.com/adapt_xxx/api/otlp/traces"
    }
  },
  "ossMountConfig": {
    "mountPoints": [
      {
        "bucketName": "my-bucket",
        "mountDir": "/mnt/dir",
        "readOnly": true,
        "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
        "bucketPath": "/my-dir"
      }
    ]
  },
  "useSLRAuthentication": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-27The response structure of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details
2021-06-29The request parameters of the API has changedView Change Details