Use the ListServices API to query services - Function Compute - Alibaba Cloud -

Retrieves a list of services.

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:ListServices

get

*Service

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

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
limit	integer	No	The maximum number of resources to return. If this parameter is not specified, the default value is 20. The maximum value is 100. The number of returned results can be less than the specified value but cannot exceed it.	20
nextToken	string	No	The token that marks the current position from which to start reading. An empty value indicates reading from the beginning. You do not need to specify this parameter for the first query. For subsequent queries, obtain the token from the response.	caeba0****be03f84eb48b699f0a4883
prefix	string	No	The prefix that the names of returned resources must contain. For example, if Prefix is set to a, the names of all returned resources start with a.	prefix_text
startKey	string	No	The key from which the results start to be returned. Results are returned in alphabetical order starting from and including the value of startKey.	nextService
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	The start date of the function invocation, in the format of 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.
nextToken	string	The token that indicates the current position from which results are read. An empty value indicates that all data has been read.	caeba0****be03f84eb48b699f0a4883
services	array<object>	The list of services.
	object	The service information.
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	Specifies whether to allow functions to access the Internet. Valid values: true: Functions are allowed to access the Internet. false: Functions are not allowed to access the Internet.	true
lastModifiedTime	string	The time when the service was last updated.	2020-04-03T05:57:28Z
logConfig	LogConfig	The log configuration. Logs generated by functions are written to the Logstore specified in this configuration.
nasConfig	NASConfig	The Apsara File Storage NAS (NAS) configuration. After this parameter is configured, functions can access the specified NAS resources.
role	string	The RAM role that grants Function Compute the required permissions. Scenarios include: Sending logs generated by functions to your Logstore. Generating tokens for functions to access other cloud resources during execution.	acs:ram::198613743****:role/fc-public-test
serviceId	string	The globally unique ID generated by the system for each service.	c910061f-**-44e6-b659-*c
serviceName	string	The name of the service.	service_name
vpcConfig	VPCConfig	The VPC configuration. After this parameter is configured, functions 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 Object Storage Service (OSS) mount configuration.
useSLRAuthentication	boolean	Indicates whether the service uses the service-linked role authorization mode. Valid values: 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

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.