All Products
Search
Document Center

Function Compute:ListServices

Last Updated:Nov 06, 2024

Queries a list of services.

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:ListServicesget
  • Service
    acs:fc:{#regionId}:{#accountId}:services/*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
limitintegerNo

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
nextTokenstringNo

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
prefixstringNo

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
startKeystringNo

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

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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

The custom request ID.

rid281s******

Response parameters

ParameterTypeDescriptionExample
object

The definition of the service.

nextTokenstring

The token used to obtain more results. If this parameter is left empty, all the results are returned.

caeba0****be03f84eb48b699f0a4883
servicesarray<object>

The list of services.

serviceArrayobject

The information about the service.

createdTimestring

The time when the service was created.

2020-04-03T05:57:28Z
descriptionstring

The description of the service.

test_description
internetAccessboolean

Indicates whether to allow functions to access the Internet. Valid values:

  • true
  • false
true
lastModifiedTimestring

The last time when the service was updated.

2020-04-03T05:57:28Z
logConfigLogConfig

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

nasConfigNASConfig

The configuration of the File Storage NAS (NAS) file system. The configuration allows functions in Function Compute to access the NAS file system.

rolestring

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
serviceIdstring

The ID generated by the system for each service, which is globally unique.

c910061f-****-44e6-b659-***c
serviceNamestring

The name of the service.

service_name
vpcConfigVPCConfig

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

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 durations of requests and internal processing durations of functions, and view the cold start durations. 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

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