Call the GetService API to query service information - Function Compute - Alibaba Cloud -

Queries information about a specified service.

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

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demo-service

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	The version or alias of the service.	test
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 elements

Element	Type	Description	Example
	object	The definition of the service.
createdTime	string	The time when the service was created.	2020-04-03T05:57:28Z
description	string	The description of the service.	demo-service-test
internetAccess	boolean	Specifies whether to allow functions to access the Internet. Valid values: true: allows functions in the specified service to access the Internet. false: does not allow functions to access the Internet.	true
lastModifiedTime	string	The time when the service was last modified.	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 RAM role that is used to grant required permissions to Function Compute. Scenarios: Sends function execution logs to your Logstore. Generates a token for a function to access other cloud resources during function execution.	acs:ram::1234567890:role/fc-test
serviceId	string	The unique ID generated by the system for the service.	2d28e0e9-9ba5-4eed-8b1a-d3d9cd24e737
serviceName	string	The name of the service.	demo-service
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 durations of requests and internal processing durations of functions, and view the cold start durations. For more information, see Overview.
ossMountConfig	OSSMountConfig	The Object Storage Service (OSS) mounting configuration.
useSLRAuthentication	boolean	Indicates whether service-linked role authorization is enabled. Valid values: true false	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.