Querying the Metadata of a Function
Function
This API is used to query the metadata of a function.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
GET /v2/{project_id}/fgs/functions/{function_urn}/config
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: None Value range: 32 characters, including letters and digits. Default value: None |
| function_urn | Yes | String | Parameter description: URN of the function. For details, see Function Model. Constraints: None Value range: Only letters, digits, underscores (_), hyphens (-), and colons (:) are allowed. Default value: None |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| is_bridge | No | String | Parameter description: Whether the bridge function is queried. Constraints: None Value range: "true" or "false" Default value: "false" |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Parameter description: User token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: None Value range: None Default value: None |
| Content-Type | No | String | Parameter description: Specifies the type (or format) of the message body. Constraints: None Value range: Only application/json is supported. Default value: application/json |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| func_id | String | Parameter description: Function ID, which uniquely identifies a function. Value range: None |
| resource_id | String | Parameter description: Unique ID of a function resource. Value range: None |
| func_urn | String | Parameter description: Function URN. Value range: None |
| func_name | String | Parameter description: Function name. Value range: None |
| domain_id | String | Parameter description: Domain name ID. Value range: None |
| namespace | String | Parameter description: Project ID. Value range: None |
| project_name | String | Parameter description: Project name. Value range: None |
| package | String | Parameter description: Group to which the function belongs. This field is defined to group functions. Value range: None |
| runtime | String | Parameter description: Runtime of a FunctionGraph function, that is, the function execution environment. Value range: Custom Custom image-based functions |
| timeout | Integer | Parameter description: Function execution timeout. If a function times out, it will be forcibly stopped. Value range: 3 to 259,200 seconds |
| handler | String | Parameter description: Handler It is in the format of "xx.xx" and must contain a period (.). The handler of a custom image function is -. For example, for Node.js function myfunction.handler, the file name is myfunction.js, and the handler function is handler. Can contain a maximum of 128 characters. Value range: 3 to 128 characters |
| memory_size | Integer | Parameter description: Memory (MB) consumed by the function. Value range: |
| gpu_memory | Integer | Parameter description: GPU memory. This parameter is available only for functions created with a custom runtime or image. The unit is MB. Value range: |
| gpu_type | String | Parameter description: Type Value range: None |
| cpu | Integer | Parameter description: CPU resources of a function. Unit: millicore (1 core = 1000 millicores). The value of this field is proportional to that of MemorySize. By default, 100 CPU millicores are required for 128 MB memory. Value range: None |
| code_type | String | Parameter description: Function code type Value range: The options are as follows: inline: inline code zip: ZIP file obs: function code stored in an OBS bucket jar: JAR file, mainly for Java functions Custom-Image-Swr: The function code comes from the SWR custom image. |
| code_url | String | Parameter description: If CodeType is set to obs, enter the OBS URL of the function code package. If CodeType is not set to obs, leave this parameter blank. Value range: OBS path |
| code_filename | String | Parameter description: Name of a function file. This parameter is mandatory only when CodeType is set to jar or zip. Value range: None |
| code_size | Long | Parameter description: Code size in bytes. Value range: None |
| user_data | String | Parameter description: Name/Value information defined for the function. These are parameters used in the function. For example, if a function needs to access a host, you can set the custom parameter Host={host_ip}. The total length cannot exceed 4 KB. Value range: json indicates a character string in JSON format. |
| encrypted_user_data | String | Parameter description: Name/value information to be encrypted. Value range: Message structure, which is a JSON string. |
| digest | String | Parameter description: SHA512 hash value of function code, which is used to determine whether the function is changed. Value range: None |
| version | String | Parameter description: Function version, which is automatically generated by the system. The version name is in the format of "vYYYYMMDD-HHMMSS" (v+year/month/day-hour/minute/second). Value range: None |
| image_name | String | Parameter description: Internal identifier of a function version. Value range: None |
| xrole | String | Parameter description: Configuration agency. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services. After specifying a function configuration agency, you can use the context method in the function handler to obtain a token, an AK, and an SK for accessing other cloud services. No agency is required if FunctionGraph does not access any cloud services. Value range: None |
| app_xrole | String | Parameter description: Execution agency. You can optimize performance by configuring a separate agency for function execution, otherwise, the same agency is used for both execution and configuration. Value range: None |
| description | String | Parameter description: Description of the function. Value range: None |
| last_modified | String | Parameter description: Time when the function was last updated. Value range: UTC time. |
| ephemeral_storage | Integer | Parameter description: Ephemeral storage. By default, the /tmp directory of each function is 512 MB. You can increase the size to 10,240 MB (10 GB) if necessary. Value range: |
| func_vpc | FuncVpc object | VPC configuration. An agency with VPC permissions must be configured for the function. |
| peering_cidr | String | Parameter description: VPC CIDR Block Enter the VPC CIDR block used in the code to check whether it conflicts with FunctionGraph's VPC CIDR block. The blocks are separated by semicolons (;) and the number of blocks cannot exceed 5. Value range: None |
| mount_config | MountConfig object | Mounting configuration. |
| depend_list | Array of strings | Parameter description: Dependency IDs. Value range: None |
| depend_version_list | Array of strings | Parameter description: Dependency versions. Value range: None |
| strategy_config | StrategyConfig object | Parameter description: Function policy configuration. |
| status | Integer | Parameter description: Function status. Value range: 0: enabled 1: disabled |
| dependencies | Array of Dependency objects | Parameter description: Dependency packages. Value range: None |
| initializer_handler | String | Parameter description: Initializer of the function in the format of "xx.xx". It must contain a period (.). ". This parameter is mandatory when the initialization function is configured. For example, for the Node.js function myfunction.initializer, the file name is myfunction.js, and the initialization input is The interface function name is initializer. Value range: None |
| initializer_timeout | Integer | Parameter description: Initialization timeout interval. The timeout function will be forcibly stopped. This parameter is mandatory when the initialization function is configured. Value range: [1, 300] |
| pre_stop_handler | String | Parameter description: The pre-stop handler of a function. The value must contain a period (.) in the format of xx.xx. ". For example, for Node.js function myfunction.pre_stop_handler, the file name is myfunction.js, and the initialization function is pre_stop_handler. Value range: None |
| pre_stop_timeout | Integer | Parameter description: Initialization timeout interval. The timeout function will be forcibly stopped. Value range: 1 to 90 seconds |
| enterprise_project_id | String | Parameter description: Enterprise project ID. This parameter is mandatory if you create a function as an enterprise user. Value range: None |
| long_time | Boolean | Parameter description: Whether to allow a long timeout. Value range: |
| log_group_id | String | Parameter description: Log group ID. Value range: None |
| log_stream_id | String | Parameter description: Log stream ID. Value range: None |
| type | String | Parameter description: Function Version Value range: |
| enable_cloud_debug | String | Parameter description: Whether to enable cloud debugging in the CloudDebug scenario (deprecated) Value range: None |
| enable_dynamic_memory | Boolean | Parameter description: Whether to enable dynamic memory allocation. Value range: false (disabled) |
| is_stateful_function | Boolean | Parameter description: Whether stateful functions are supported. If they are supported, set this parameter to true. This parameter is supported in FunctionGraph v2. Value range: |
| is_bridge_function | Boolean | Parameter description: Whether this is a bridge function. Value range: false: no. |
| enable_auth_in_header | Boolean | Parameter description: Whether to allow authentication information to be added to the request header. Only custom image functions are supported. Value range: false: An anonymous request is not allowed. |
| custom_image | CustomImage object | Parameter description: Container image. |
| reserved_instance_idle_mode | Boolean | Parameter description: Whether to enable idle mode for reserved instances. Value range: true: Enabled. |
| apig_route_enable | Boolean | Parameter description: Whether to configure gateway routing rules. Value range: true: configure false: not configure |
| heartbeat_handler | String | Parameter description: Entry of the heartbeat function. The rule is xx.xx. The value must contain a period (.). Only Java runtime is supported. The heartbeat function entry must be in the same file as your function handler. This parameter is mandatory when the heartbeat function is enabled. Value range: None |
| enable_class_isolation | Boolean | Parameter description: Indicates whether to enable class isolation. This parameter can be configured only for Java functions. Enable to dump logs to Kafka and improve class loading efficiency. However, this may cause compatibility issues. Value range: true: Enable class isolation. false: Disable class isolation. |
| allow_ephemeral_storage | Boolean | Parameter description: Indicates whether ephemeral storage can be configured. Value range: true: Enable temporary storage configuration. false: not configure |
| network_controller | NetworkControlConfig object | Network configuration. |
| is_return_stream | Boolean | Parameter description: Whether to return stream data. (discarded) Value range: None |
| lts_custom_tag | Map<String,String> | Definition Custom log tag. You can use these tags to filter function logs in LTS. Value range: String mapping pair |
| Parameter | Type | Description |
|---|---|---|
| domain_id | String | Parameter description: Tenant account ID. Value range: None |
| namespace | String | Parameter description: Project ID. Value range: None |
| vpc_name | String | Definition: VPC name Value range: None |
| vpc_id | String | Parameter description: VPC ID. Value range: None |
| subnet_name | String | Parameter description: Subnet name. Value range: None |
| subnet_id | String | Parameter description: Subnet ID. Value range: None |
| cidr | String | Parameter description: Subnet mask. Value range: None |
| gateway | String | Parameter description: Gateway. Value range: None |
| security_groups | Array of strings | Parameter description: Security Group Value range: Character string list |
| is_safety | Boolean | Definition Whether to enable secure access. When secure access is enabled, you need to configure the VPCEP network to establish a secure VPC connection to private domain names. Once enabled, this feature cannot be disabled. Range |
| Parameter | Type | Description |
|---|---|---|
| mount_user | MountUser object | User information. |
| func_mounts | Array of FuncMount objects | Parameter description: Mounted resources. Value range: None |
| Parameter | Type | Description |
|---|---|---|
| user_id | Integer | Parameter description: User ID. Value range: An integer ranging from -1 to 65534 |
| user_group_id | Integer | Parameter description: Group ID Value range: An integer ranging from -1 to 65534 |
| Parameter | Type | Description |
|---|---|---|
| mount_type | String | Definition Mount type. This parameter is mandatory when func_mounts is not empty. Range |
| mount_resource | String | Parameter description: ID of the mounted resource (cloud service ID). This parameter is mandatory when func_mounts is not empty. Value range: None |
| mount_share_path | String | Parameter description: Remote mount path. For example, 192.168.0.12:/data. This parameter is mandatory if mount_type is set to ecs. Value range: Shared path opened by the ECS |
| local_mount_path | String | Parameter description: Function access path. This parameter is mandatory when func_mounts is not empty. Value range: Mount directory in the function container. The directory is generally a two-layer structure. |
| Parameter | Type | Description |
|---|---|---|
| concurrency | Integer | Parameter description: Specifies the maximum number of instances for a function. The value -1 indicates that the number of instances is not limited. Value range: v1: 0 and -1 v2: [–1, 1000] |
| concurrent_num | Integer | Parameter description: Specifies the number of concurrent requests per instance. This parameter is supported in v2. Value range: [1, 1000] |
| Parameter | Type | Description |
|---|---|---|
| id | String | Parameter description: Dependency version ID. Value range: None |
| owner | String | Parameter description: Domain ID of the dependency owner. Value range: None |
| link | String | Parameter description: URL of the dependency on OBS. Value range: OBS link |
| runtime | String | Parameter description: Runtime of a function. Value range: Custom Custom image-based functions |
| etag | String | Parameter description: MD5 value of a dependency. Value range: None |
| size | Long | Parameter description: Dependency size. Value range: None |
| name | String | Parameter description: Name of a dependency package. Value range: None |
| description | String | Parameter description: Dependency description. Value range: None |
| file_name | String | Parameter description: File name of a dependency package (ZIP). Value range: None |
| version | Long | Parameter description: Dependency version ID. Value range: None |
| dep_id | String | Parameter description: Dependency ID. Value range: None |
| last_modified | String | Parameter description: Time when the function was last updated. Value range: None |
| Parameter | Type | Description |
|---|---|---|
| enabled | Boolean | Parameter description: Whether to use an image. If no image is used, the following parameters do not take effect. Value range: true: An image is used. false: No image is used. |
| image | String | Parameter description: Image address. Value range: None |
| command | String | Parameter description: Command for starting a container image. Value range: None |
| args | String | Parameter description: Command line parameter for starting a container image. Value range: None |
| working_dir | String | Parameter description: Working directory of an image container. Value range: None |
| uid | String | Parameter description: User ID of an image container. Value range: None |
| gid | String | Parameter description: User group ID of an image container. Value range: None |
| is_public | Boolean | Parameter description: Whether the image is a public image. Value range: None |
| Parameter | Type | Description |
|---|---|---|
| disable_public_network | Boolean | Parameter description: Disable public access. Value range: true: public network access is disabled. false: public network access is allowed. |
| trigger_access_vpcs | Array of VpcConfig objects | Parameter description: VPC access restriction. Value range: None |
| Parameter | Type | Description |
|---|---|---|
| vpc_name | String | Parameter description: VPC name. Value range: None |
| vpc_id | String | VPC ID. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Example Requests
Query the metadata of a function.
GET https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/config Example Responses
Status code: 200
{
"func_id" : "0d075978-5a54-4ee1-8e24-ff5bd070xxxx",
"resource_id" : "0d075978-5a54-4ee1-8e24-ff5bd070xxxx:test",
"func_urn" : "urn:fss:xxxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test:latest",
"func_name" : "test",
"domain_id" : "14ee2e3501124efcbca7998baa24xxxx",
"namespace" : "46b6f338fc3445b8846c71dfb1fbxxxx",
"project_name" : "xxxxxxxxx",
"package" : "default",
"runtime" : "Node.js6.10",
"timeout" : 3,
"handler" : "test.handler",
"memory_size" : 128,
"cpu" : 100,
"code_type" : "inline",
"code_filename" : "index.js",
"code_size" : 272,
"digest" : "faa825575c45437cddd4e369bea69893bcbe195d478178462ad90984fe72993f3f59d15f41c5373f807f3e05fb9af322c55dabeb16565c386e402413458e6068",
"version" : "latest",
"ephemeral_storage" : 512,
"image_name" : "latest-191025153727@zehht",
"last_modified" : "2019-10-25 15:37:27",
"status" : 0,
"strategy_config" : {
"concurrency" : 0
}
} Status code: 404
{
"error_code" : "FSS.1051",
"error_msg" : "Not found the function"
} SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion; import com.huaweicloud.sdk.functiongraph.v2.*; import com.huaweicloud.sdk.functiongraph.v2.model.*; public class ShowFunctionConfigSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); FunctionGraphClient client = FunctionGraphClient.newBuilder() .withCredential(auth) .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>")) .build(); ShowFunctionConfigRequest request = new ShowFunctionConfigRequest(); request.withFunctionUrn("{function_urn}"); try { ShowFunctionConfigResponse response = client.showFunctionConfig(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkfunctiongraph.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = FunctionGraphClient.new_builder() \ .with_credentials(credentials) \ .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowFunctionConfigRequest() request.function_urn = "{function_urn}" response = client.show_function_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := functiongraph.FunctionGraphClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := functiongraph.NewFunctionGraphClient(hcClient) request := &model.ShowFunctionConfigRequest{} request.FunctionUrn = "{function_urn}" response, err := client.ShowFunctionConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad request. |
| 401 | Unauthorized. |
| 403 | Forbidden. |
| 404 | Not found. |
| 500 | Internal server error. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot