Use the UpdateService API to update a service - Function Compute - Alibaba Cloud -

Updates service information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:UpdateService

update

*Service

acs:fc:{#regionId}:{#accountId}:services/{#ServiceName}

fc:EnableServiceSLSLogging
fc:EnableServiceInternetAccess

None

Request syntax

PUT /2021-04-06/services/{serviceName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demo-service

Request parameters

Parameter	Type	Required	Description	Example
If-Match	string	No	Ensures that the service being modified matches the expected service. The value is obtained from the responses of the CreateService, UpdateService, and GetService operations.	e19d5cd5af0378da05f63f891c7467af
body	object	No	The service definition.
description	string	No	The description of the service.	test service
internetAccess	boolean	No	Specifies whether to allow the function to access the Internet: true: The function is allowed to access the Internet. false: The function is not allowed to access the Internet.	true
logConfig	LogConfig	No	The log configuration. Logs generated by the function are written to the Logstore specified in this configuration.
nasConfig	NASConfig	No	The NAS configuration. After this configuration is set, the function can access the specified NAS resources.
role	string	No	The RAM role that grants Function Compute the required permissions. Scenarios include: Sending logs generated by the function to your Logstore. Generating tokens for the function to access other cloud resources during execute.	acs:ram::1234567890:role/fc-test
vpcConfig	VPCConfig	No	The VPC configuration. After this configuration is set, Function Compute can access the specified VPC resources.
tracingConfig	TracingConfig	No	The tracing configuration. After Function Compute is integrated with Tracing Analysis, you can record the time consumed by requests in Function Compute, view the cold start time of functions, and record the time consumed within functions. For more information, see Tracing Analysis.
ossMountConfig	OSSMountConfig	No	The OSS mount configuration.
X-Fc-Account-Id	string	No	Your Alibaba Cloud account ID.	188077086902****
X-Fc-Date	string	No	The time when the Function Compute API is called. The format 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.	rid281s******

Response elements

Element	Type	Description	Example
	object	The definition of the service.
createdTime	string	The time when the service was created.	2016-08-15T16:06:05.000+0000
description	string	The description of the service.	test_description
internetAccess	boolean	Specifies whether to allow the function to access the Internet: true: The function is allowed to access the Internet. false: The function is not allowed to access the Internet.	true
lastModifiedTime	string	The time when the service was last updated.	2016-08-15T16:06:05.000+0000
logConfig	LogConfig	The log configuration. Logs generated by the function are written to the Logstore specified in this configuration.
nasConfig	NASConfig	The NAS configuration. After this configuration is set, the function can access the specified NAS resources.
role	string	The RAM role that grants Function Compute the required permissions. Scenarios include: Sending logs generated by the function to your Logstore. Generating tokens for the function to access other cloud resources during execute.	acs:ram::1234567890: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.	demo-service
vpcConfig	VPCConfig	The VPC configuration. After this configuration is set, the function can access the specified VPC resources.
tracingConfig	TracingConfig	The tracing configuration. After Function Compute is integrated with Tracing Analysis, you can record the time consumed by requests in Function Compute, view the cold start time of functions, and record the time consumed within functions. For more information, see Tracing Analysis.
ossMountConfig	OSSMountConfig	The OSS mount configuration.
useSLRAuthentication	boolean	Indicates whether the service uses the service-linked role authorization mode: true: The service uses the service-linked role authorization mode. false: The service does not use the service-linked role authorization mode.	true

Examples

Success response

JSON format

{
  "createdTime": "2016-08-15T16:06:05.000+0000",
  "description": "test_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::1234567890:role/fc-test",
  "serviceId": "2d28e0e9-9ba5-4eed-8b1a-d3d9cd24e737",
  "serviceName": "demo-service",
  "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"
      }
    ]
  },
  "useSLRAuthentication": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.