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

Queries a list of services.

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

Request parameters

Parameter	Type	Required	Description	Example
limit	integer	No	The maximum number of resources to return. Default value: 20. The value cannot exceed 100. The number of returned configurations is less than or equal to the specified number.	20
nextToken	string	No	The starting position of the query. If this parameter is left empty, the query starts from the beginning. You do not need to specify this parameter in the first query. If the number of asynchronous tasks exceeds the limit, the nextToken parameter is returned, the value of which can be used in subsequent calls to obtain more results.	caeba0****be03f84eb48b699f0a4883
prefix	string	No	The prefix that the names of returned resources must contain. If the name prefix is a, the names of returned resources must start with a.	prefix_text
startKey	string	No	The returned resources are sorted in alphabetical order, and the resources that include and follow the resource specified by the startKey parameter are returned.	nextService
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
	object	The definition of the service.
nextToken	string	The token used to obtain more results. If this parameter is left empty, all the results are returned.	caeba0****be03f84eb48b699f0a4883
services	object []	The list of services.
createdTime	string	The time when the service was created.	2020-04-03T05:57:28Z
description	string	The description of the service.	test_description
internetAccess	boolean	Indicates whether to allow functions to access the Internet. Valid values: true false	true
lastModifiedTime	string	The last time when the service was updated.	2020-04-03T05:57:28Z
logConfig	LogConfig	The logging configurations. Function Compute writes function execution logs to the specified Logstore.
nasConfig	NASConfig	The configuration of the Apsara File Storage NAS (NAS) file system. The configuration allows functions in the specified service in Function Compute to access the NAS file system.
role	string	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::198613743****:role/fc-public-test
serviceId	string	The ID generated by the system for each service, which is globally unique.	c910061f-**-44e6-b659-*c
serviceName	string	The name of the service.	service_name
vpcConfig	VPCConfig	The VPC configurations, which allow functions in the specified service to access the specified VPC.
tracingConfig	TracingConfig	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 .
ossMountConfig	OSSMountConfig	The Object Storage Service (OSS) mounting configurations.
useSLRAuthentication	boolean	Indicates whether service-linked role authorization is enabled. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "nextToken": "caeba0****be03f84eb48b699f0a4883",
  "services": [
    {
      "createdTime": "2020-04-03T05:57:28Z",
      "description": "test_description",
      "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::198613743****:role/fc-public-test",
      "serviceId": "c910061f-****-44e6-b659-***c",
      "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"
          }
        ]
      },
      "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