ListServices - 获取服务列表

获取服务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
fc:ListServicesget
  • Service
    acs:fc:{#regionId}:{#accountId}:services/*

请求语法

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

请求参数

名称类型必填描述示例值
limitinteger

限定此次返回资源的数量。如果不设定,默认返回 20,最大不能超过 100。返回结果可以小于指定的数量,但不会多于指定的数量。

20
nextTokenstring

用来标记当前开始读取的位置,置空表示从头开始。第一次查询不需要提供这个参数,后续查询的 Token 从返回结果中获取。

caeba0****be03f84eb48b699f0a4883
prefixstring

限定返回的资源名称,名称必须以 Prefix 作为前缀,例如 Prefix 是 a,则返回的资源名均是以 a 开始的。

prefix_text
startKeystring

设定结果从 startKey 之后(包括 startKey)按字母排序的第一个开始返回。

nextService
X-Fc-Account-Idstring

您的阿里云账号(主账号)ID。

188077086902****
X-Fc-Datestring

函数的调用开始日期,格式为EEE,d MMM yyyy HH:mm:ss GMT

Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Idstring

自定义请求 ID。

rid281s******

返回参数

名称类型描述示例值
object

服务的定义。

nextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。

caeba0****be03f84eb48b699f0a4883
servicesarray<object>

服务列表。

serviceArrayobject

服务信息。

createdTimestring

服务的创建时间。

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

服务的描述。

test_description
internetAccessboolean

是否允许函数访问公网:

  • true:允许函数访问公网。
  • false:不允许函数访问公网。
true
lastModifiedTimestring

服务上一次被更新的时间。

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

日志配置,函数产生的日志会写入这里配置的 Logstore。

nasConfigNASConfig

NAS 配置,配置后函数可以访问指定 NAS 资源。

rolestring

授予函数计算所需权限的 RAM 角色,使用场景包含:

  • 把函数产生的日志发送到您的 Logstore 中。
  • 为函数在执行中访问其他云资源生成 Token。
acs:ram::198613743****:role/fc-public-test
serviceIdstring

系统为每个服务生成的 ID,全网唯一。

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

服务的名称。

service_name
vpcConfigVPCConfig

VPC 配置,配置后函数可以访问指定 VPC 资源。

tracingConfigTracingConfig

链路追踪配置。当函数计算与链路追踪集成后,您可以记录请求在函数计算的耗时时间、查看函数的冷启动时间、记录函数内部时间的消耗等,更多信息,请参见链路追踪

ossMountConfigOSSMountConfig

OSS 挂载配置。

useSLRAuthenticationboolean

服务是否使用服务关联角色授权模式:

  • true:使用服务关联角色授权模式。
  • false:未使用服务关联角色授权模式。
true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-27OpenAPI 返回结构发生变更查看变更详情
2021-06-30OpenAPI 入参发生变更查看变更详情
2021-06-30OpenAPI 入参发生变更查看变更详情
2021-06-30OpenAPI 入参发生变更查看变更详情