Querying Function Templates
Function
This API is used to query function templates.
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/templates
| 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| marker | No | String | Start position of the current query. The default value is 0. |
| maxitems | No | String | Maximum number of templates obtained in each query. |
| ispublic | No | String | Indicates whether the template is public. |
| runtime | No | String | Runtime template. |
| scene | No | String | Scenario template. |
| service | No | String | Cloud service template. |
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_templates | Array of ShowFunctionTemplateResponseBody objects | Function templates. |
| next_marker | Integer | Next read location. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Template ID. |
| type | Integer | Template type. |
| title | String | Template title. |
| template_name | String | Template name. |
| description | String | Template description. |
| runtime | String | Parameter description: Runtime of a FunctionGraph function, that is, the function execution environment. Range Custom image-based functions |
| handler | String | 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. |
| code_type | String | Code type. |
| code | String | Code file. |
| timeout | Integer | Maximum duration the function can be executed. Value range: 3s–259,200s. |
| memory_size | Integer | Parameter description: Memory (MB) consumed by the function. Range |
| trigger_metadata_list | Array of TriggerMetadataList objects | Trigger information. |
| temp_detail | TempDetail object | |
| user_data | String | User data. |
| encrypted_user_data | String | Encrypted user data. |
| dependencies | Array of strings | Dependencies required by the template. |
| scene | String | Template application scenarios. |
| service | String | Cloud service associated with the template. |
| Parameter | Type | Description |
|---|---|---|
| trigger_name | String | Trigger name. |
| trigger_type | String | Trigger type. |
| event_type | String | Event type. |
| event_data | String | Event data. |
| Parameter | Type | Description |
|---|---|---|
| input | String | Template input. |
| output | String | Template output. |
| warning | String | Warning. |
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: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Example Requests
Query 500 public function templates.
GET /v2/{project_id}/fgs/templates?marker=0&maxitems=500&ispublic=true Example Responses
Status code: 200
{
"func_templates" : [ {
"id" : "d3aa6e4c-xxxx-xxxx-9c09-5c50c4xxxxxx",
"type" : 1,
"title" : "access-service-with-http",
"template_name" : "access-service-with-http-php",
"description" : "access service with http.",
"runtime" : "PHP7.3",
"handler" : "index.handler",
"code_type" : "inline",
"code" : "xxxxx",
"timeout" : 30,
"memory_size" : 256,
"trigger_metadata_list" : [ ],
"temp_detail" : {
"input" : "None",
"output" : "execution succeed: Return to access service information through http/https,",
"warning" : "1. configure the serveraddress environment variables."
},
"user_data" : "",
"encrypted_user_data" : "",
"dependencies" : [ ],
"scene" : "basic_function_usage",
"service" : "FunctionGraph"
} ],
"next_marker" : 1
} 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 | 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 ListFunctionTemplateSolution { 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(); ListFunctionTemplateRequest request = new ListFunctionTemplateRequest(); try { ListFunctionTemplateResponse response = client.listFunctionTemplate(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 | # 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 = ListFunctionTemplateRequest() response = client.list_function_template(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 | 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.ListFunctionTemplateRequest{} response, err := client.ListFunctionTemplate(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. |
| 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