All Products
Search
Document Center

Function Compute:UpdateService

Last Updated:Nov 01, 2024

Updates 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:UpdateServiceupdate
  • Service
    acs:fc:{#regionId}:{#accountId}:services/{#ServiceName}
  • fc:EnableServiceSLSLogging
  • fc:EnableServiceInternetAccess
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
If-MatchstringNo

The value used to ensure that the modified service is consistent with the service to be modified. The value is obtained from the responses of the CreateService , UpdateService , and GetService operations.

e19d5cd5af0378da05f63f891c7467af
serviceNamestringYes

The name of the service.

demo-service
bodyobjectNo

The definition of the service.

descriptionstringNo

The description of the service.

test service
internetAccessbooleanNo

Whether to allow functions to access the Internet. Valid values:

  • true
  • false
true
logConfigLogConfigNo

The logging configurations. Function execution logs are stored in the specified Logstores.

nasConfigNASConfigNo

The configurations of the File Storage NAS (NAS) file system. The configurations allow functions to access the 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 Alibaba Cloud resources during function execution.
acs:ram::1234567890:role/fc-test
vpcConfigVPCConfigNo

The VPC configurations. The configurations Function Compute to access the specified VPC resources.

tracingConfigTracingConfigNo

The configurations of Managed Service for OpenTelemetry. After you configure Managed Service for OpenTelemetry for a service in Function Compute, you can record the execution duration of a request, view the amount of cold start time for a function, and record execution duration of a function. For more information, see Overview .

ossMountConfigOSSMountConfigNo

The Object Storage Service (OSS) mounting configuration.

X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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

The custom request ID.

rid281s******

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 definition of the service.

createdTimestring

The time when the service was created.

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

The description of the service.

test_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 to access the Internet.
true
lastModifiedTimestring

The time when the service was last modified.

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

The logging configurations. Function Compute writes function execution logs to the specified Logstores.

nasConfigNASConfig

The configuration of the File Storage NAS (NAS) file system. The configuration allows functions to access the 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::1234567890: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.

demo-service
vpcConfigVPCConfig

The VPC configurations, which allow functions to access specified VPC resources.

tracingConfigTracingConfig

The configurations of Managed Service for OpenTelemetry. After you configure Managed Service for OpenTelemetry for a service in Function Compute, you can record the execution duration of a request, view the amount of cold start time for a function, and record execution duration of a function. For more information, see Overview .

ossMountConfigOSSMountConfig

The Object Storage Service (OSS) mounting configuration.

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": "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": ""
  },
  "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-30The request parameters of the API has changedView Change Details