GetService - Function Compute (2.0) - Alibaba Cloud Documentation Center

Queries information about a specified service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /2021-04-06/services/{serviceName}

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demo-service
qualifier	string	No	The version or alias of the service.	test
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.	rid281s******

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 definition of the service.
createdTime	string	The time when the service was created.	2020-04-03T05:57:28Z
description	string	The description of the service.	demo-service-test
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 to access the Internet.	true
lastModifiedTime	string	The time when the service was last modified.	2020-04-03T05:57:28Z
logConfig	LogConfig	The log configuration, which specifies a Logstore to store function execution logs.
nasConfig	NASConfig	The configurations of the NAS file system. The configuration allows functions in the specified service in Function Compute to access the NAS file system.
role	string	The RAM role that is used to grant required permissions to Function Compute. 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
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. The configuration allows a function to access the specified VPC.
tracingConfig	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 amount of cold start time for a function, and record the execution duration of a function. For more information, see Overview .
ossMountConfig	OSSMountConfig	The OSS mount configurations.
useSLRAuthentication	boolean	Indicates whether service-linked role authorization is enabled. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "createdTime": "2020-04-03T05:57:28Z",
  "description": "demo-service-test",
  "internetAccess": true,
  "lastModifiedTime": "2020-04-03T05:57:28Z",
  "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

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

Change history

Change time

Summary of changes

Operation

2023-12-27

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2021-06-30

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: X-Fc-Account-Id
	Added Input Parameters: X-Fc-Code-Checksum
	Added Input Parameters: X-Fc-Log-Type
	Added Input Parameters: X-Fc-Invocation-Type
	Added Input Parameters: X-Fc-Date
	Added Input Parameters: X-Fc-Trace-Id

2021-06-30

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: X-Fc-Account-Id

2021-06-30

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: X-Fc-Account-Id