GetService - 获取服务信息

更新时间: 2024-03-03 14:18:53

查询指定的服务信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

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

服务的名称。

demo-service
qualifierstring

服务的版本或别名。

test
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******

返回参数

名称类型描述示例值
headersobject
ETagstring

用于更改服务的 ETag,以确保实际更改的服务和期望更改的服务是一致的。

5e547e5605e1dc17a78a6191bc18fbc5
object

服务定义。

createdTimestring

服务的创建时间。

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

服务的描述。

demo-service-test
internetAccessboolean

是否允许函数访问公网:

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

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

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

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

nasConfigNASConfig

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

rolestring

服务中函数所使用的角色,使函数可以获得角色所拥有的权限,实现跨产品访问。使用场景包含:

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

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

2d28e0e9-9ba5-4eed-8b1a-d3d9cd24e737
serviceNamestring

服务的名称。

demo-service
vpcConfigVPCConfig

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

tracingConfigTracingConfig

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

ossMountConfigOSSMountConfig

OSS 挂载配置。

useSLRAuthenticationboolean

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

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-06-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:X-Fc-Account-Id
    新增入参:X-Fc-Code-Checksum
    新增入参:X-Fc-Log-Type
    新增入参:X-Fc-Invocation-Type
    新增入参:X-Fc-Date
    新增入参:X-Fc-Trace-Id
2021-06-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:X-Fc-Account-Id
2021-06-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:X-Fc-Account-Id
阿里云首页 函数计算(旧版) 相关技术圈