CLI Command Reference
Function Quotas
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Tenant Quotas | hcloud FunctionGraph ListQuotas | This API is used to query tenant quotas. |
Dependencies
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Dependencies | hcloud FunctionGraph ListDependencies | This API is used to query all dependencies. | |
| Creating a Dependency Version | hcloud FunctionGraph CreateDependencyVersion | This API is used to create a dependency version. | |
| Querying Dependency Versions | hcloud FunctionGraph ListDependencyVersion | This API is used to query dependency versions. | |
| Querying a Dependency Version | hcloud FunctionGraph ShowDependencyVersion | This API is used to query the details about a dependency version. | |
| Deleting a Dependency Version | hcloud FunctionGraph DeleteDependencyVersion | This API is used to delete a dependency version. |
Test Events
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Test Events of a Function | hcloud FunctionGraph ListEvents | This API is used to query the test events of a function. | |
| Creating a Test Event | hcloud FunctionGraph CreateEvent | This API is used to create a test event. | |
| Obtaining the Details of a Test Event | hcloud FunctionGraph ShowEvent | This API is used to query the details of a test event. | |
| Updating a Test Event | hcloud FunctionGraph UpdateEvent | This API is used to update a test event. | |
| Deleting a Test Event | hcloud FunctionGraph DeleteEvent | This API is used to delete a test event. |
Function Tracing
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Tracing Configuration | hcloud FunctionGraph ShowTracing | This API is used to query the tracing configuration of a function. | |
| Modifying Tracing Configuration | hcloud FunctionGraph UpdateTracing | This API is used to modify the tracing configuration of a function. You can enable or modify the AK/SK or disable the AK/SK. |
Application
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Application Templates | hcloud FunctionGraph ListAppTemplates | This API is used to query application templates. | |
| Querying Details About an Application Template | hcloud FunctionGraph ShowAppTemplate | This API is used to query details about an application template. | |
| Querying Applications | hcloud FunctionGraph ListFunctionApplications | This API is used to query applications. | |
| Creating an Application | hcloud FunctionGraph CreateFunctionApp | This API is used to create an application. | |
| Querying Application Details | hcloud FunctionGraph ShowFunctionApp | This API is used to query application details. | |
| Deleting Applications | hcloud FunctionGraph DeleteFunctionApp | This API is used to delete applications. |
Function Lifecycle Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Functions | hcloud FunctionGraph ListFunctions | This API is used to query all functions. | |
| Creating a Function | hcloud FunctionGraph CreateFunction | This API is used to create a function. | |
| Deleting a Function or Function Version | hcloud FunctionGraph DeleteFunction | This API is used to delete a function or a non-latest version of a function. | |
| Querying the Code of a Function | hcloud FunctionGraph ShowFunctionCode | This API is used to query the code of a function. | |
| Modifying the Code of a Function | hcloud FunctionGraph UpdateFunctionCode | This API is used to modify the code of a function. | |
| Querying the Metadata of a Function | hcloud FunctionGraph ShowFunctionConfig | This API is used to query the metadata of a function. | |
| Modifying the Metadata of a Function | hcloud FunctionGraph UpdateFunctionConfig | This API is used to modify the metadata of a function. | |
| Updating Max. Instances of a Function | hcloud FunctionGraph UpdateFunctionMaxInstanceConfig | This API is used to update the maximum number of instances of a function. | |
| Enabling or Disabling the Snapshot Function | hcloud FunctionGraph UpdateFuncSnapshot | This API is used to enable or disable the snapshot feature. It is available only for non-latest versions of Java functions. | |
| Querying Snapshot Status | hcloud FunctionGraph ShowFuncSnapshotState | This API is used to query snapshot status. | |
| Querying Resources | hcloud FunctionGraph ShowResInstanceInfo | This API is used to query resources. | |
| Querying Resource Tags | hcloud FunctionGraph ShowProjectTagsList | This API is used to query resource tags. | |
| Querying Function Tags | hcloud FunctionGraph ListFunctionTags | This API is used to query function tags. | |
| Creating Resource Tags | hcloud FunctionGraph CreateTags | This API is used to create resource tags. | |
| Deleting Resource Tags | hcloud FunctionGraph DeleteTags | This API is used to delete resource tags. | |
| Creating a VPC Endpoint | hcloud FunctionGraph CreateVpcEndpoint | This API is used to create a VPC endpoint. | |
| Deleting a VPC Endpoint | hcloud FunctionGraph DeleteVpcEndpoint | This API is used to delete a VPC endpoint. | |
| Querying ServiceBridge Functions Bound to a Specified Function | hcloud FunctionGraph ListBridgeFunctions | This API is used to query ServiceBridge functions bound to a specified function. | |
| Querying the Available ServiceBridge Version | hcloud FunctionGraph ListBridgeVersions | This API is used to query the available ServiceBridge version. | |
| Updating the Pinning Status of a Function | hcloud FunctionGraph UpdateFunctionCollectState | This API is used to update the pinning status of a function. |
Versions and Aliases
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Versions and Aliases of a Function | hcloud FunctionGraph ListVersionAliases | This API is used to query the versions and aliases of a function. | |
| Creating an Alias for a Function Version | hcloud FunctionGraph CreateVersionAlias | This API is used to create an alias for a function version. | |
| Querying the Alias of a Function Version | hcloud FunctionGraph ShowVersionAlias | This API is used to query the alias of a function version. | |
| Modifying the Alias of a Function Version | hcloud FunctionGraph UpdateVersionAlias | This API is used to modify the alias of a function version. | |
| Deleting an Alias of a Function Version | hcloud FunctionGraph DeleteVersionAlias | This API is used to delete an alias of a function version. | |
| Querying the Versions of a Function | hcloud FunctionGraph ListFunctionVersions | This API is used to query the versions of a function. | |
| Publishing a Function Version | hcloud FunctionGraph CreateFunctionVersion | This API is used to publish a function version. |
Function Metrics
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Top Functions for a Specified Metric | hcloud FunctionGraph ListFunctionAsMetric | This API is used to query the top functions for a specified metric. | |
| Querying Tenant-Level Function Statistics | hcloud FunctionGraph ListStatistics | This API is used to query tenant-level function statistics. | |
| Querying Instance Usage Metrics of a Specified Function | hcloud FunctionGraph ShowFuncReservedInstanceMetrics | Query instance usage metrics of a function. | |
| Querying Instance Traffic Metrics of a Function | hcloud FunctionGraph ShowFunctionMetrics | This API is used to query the instance traffic metrics of a function. | |
| Querying Metrics in a Specified Period | hcloud FunctionGraph ListFunctionStatistics | This API is used to query metrics of a function in a specified period. |
Function Logs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Log Group and Stream of a Function | hcloud FunctionGraph ShowLtsLogDetails | This API is used to query the LTS log group and stream settings of a function. | |
| Enabling Log Reporting to LTS | hcloud FunctionGraph EnableLtsLogs | This API is used to enable log reporting to LTS. | |
| Enabling Asynchronous Status Notification | hcloud FunctionGraph EnableAsyncStatusLog | Enable asynchronous status notification. | |
| Querying Details About Asynchronous Invocation Logs | hcloud FunctionGraph ShowProjectAsyncStatusLogInfo | This API is used to query details about asynchronous invocation logs. |
Templates
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Function Templates | hcloud FunctionGraph ListFunctionTemplate | This API is used to query function templates. | |
| Querying a Specified Function Template | hcloud FunctionGraph ShowFunctionTemplate | This API is used to query a specified function template. |
Reserved Instances
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Reserved Instances of a Function | hcloud FunctionGraph ListReservedInstanceConfigs | This API is used to query reserved instances of a function. | |
| Changing the Number of Reserved Instances | hcloud FunctionGraph UpdateFunctionReservedInstancesCount | This API is used to change the number of reserved instances. | |
| Querying the Number of Reserved Instances | hcloud FunctionGraph ListFunctionReservedInstances | This API is used to query the number of instances reserved for a function. |
Function Import and Export
Function Invocation
| API Name | Command | Description | Operation |
|---|---|---|---|
| Executing a Function Synchronously | hcloud FunctionGraph InvokeFunction | This API is used to execute a function synchronously. Clients must wait for explicit responses to their requests from the function. Responses are returned only after function invocation is complete. | |
| Executing a Function Asynchronously | hcloud FunctionGraph AsyncInvokeFunction | This API is used to execute a function asynchronously. |
Function Triggers
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Triggers of a Function | hcloud FunctionGraph ListFunctionTriggers | This API is used to query all triggers of a function. | |
| Creating a Trigger | hcloud FunctionGraph CreateFunctionTrigger | This API is used to create a trigger. | |
| Deleting All Triggers of a Function | hcloud FunctionGraph BatchDeleteFunctionTriggers | This API is used to delete all triggers of a function. | |
| Querying a Trigger | hcloud FunctionGraph ShowFunctionTrigger | This API is used to query a specified trigger. | |
| Updating a Trigger | hcloud FunctionGraph UpdateTrigger | This API is used to update a trigger. | |
| Deleting a Trigger | hcloud FunctionGraph DeleteFunctionTrigger | This API is used to delete a trigger. |
Function Flows
| API Name | Command | Description | Operation |
|---|---|---|---|
| Executing a Function Flow Synchronously | hcloud FunctionGraph StartSyncWorkflowExecution | This API is used to execute a function flow synchronously. It is supported only for express flows. | |
| Querying Instances of a Flow | hcloud FunctionGraph ListWorkflowExecutions | This API is used to query the instances of a flow. | |
| Executing a Function Flow | hcloud FunctionGraph StartWorkflowExecution | This API is used to execute a function flow asynchronously. | |
| Querying a Flow | hcloud FunctionGraph ListWorkflow | This API is used to query a function flow. | |
| Creating a Flow | hcloud FunctionGraph CreateWorkflow | This API is used to create a function flow. | |
| Deleting Flows | hcloud FunctionGraph BatchDeleteWorkflows | This API is used to delete specified function flows. | |
| Querying a Flow Instance | hcloud FunctionGraph ShowWorkflowExecution | This API is used to query a specified instance of a function flow. | |
| Querying Metadata of a Flow Instance | hcloud FunctionGraph ShowWorkFlow | This API is used to query the metadata of specified function flow instance. | |
| Modifying Metadata of a Flow Instance | hcloud FunctionGraph UpdateWorkFlow | This API is used to modify the metadata of a specified function flow instance. | |
| Querying Flow Metrics | hcloud FunctionGraph ShowTenantMetric | This API is used to query metrics of all function flows. | |
| Querying Metrics of a Flow | hcloud FunctionGraph ShowWorkFlowMetric | This API is used to query the metrics of a function flow. | |
| Re-executing a Flow | hcloud FunctionGraph RetryWorkFlow | This API is used to re-execute a function flow. | |
| Stopping a Flow | hcloud FunctionGraph StopWorkFlow | This API is used to stop a function flow. | |
| Paging to get the list of execution instances of the specified function stream | hcloud FunctionGraph ShowWorkflowExecutionForPage | Paging to get the list of execution instances of the specified function stream | |
| Calling Back a Flow | hcloud FunctionGraph CreateCallbackWorkflow | This API is used to call back a flow. |
Asynchronous Execution Notification
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Asynchronous Execution Notification Settings of a Function Version | hcloud FunctionGraph ShowFunctionAsyncInvokeConfig | This API is used to query the asynchronous invocation setting of a function version. | |
| Configuring Asynchronous Execution Notification | hcloud FunctionGraph UpdateFunctionAsyncInvokeConfig | This API is used to configure asynchronous execution notification for a function. | |
| Deleting Asynchronous Execution Notification Settings | hcloud FunctionGraph DeleteFunctionAsyncInvokeConfig | This API is used to delete the asynchronous execution notification settings of a function. | |
| Querying Asynchronous Execution Notification Settings of a Function's All Versions | hcloud FunctionGraph ListFunctionAsyncInvokeConfig | This API is used to query the asynchronous execution notification settings of a function's all versions. | |
| Querying Asynchronous Invocation Requests | hcloud FunctionGraph ListAsyncInvocations | This API is used to query the asynchronous invocation requests of a function. | |
| Querying Active Asynchronous Invocation Requests | hcloud FunctionGraph ListActiveAsyncInvocations | This API is used to query active asynchronous invocation requests. | |
| Stopping an Asynchronous Invocation Request | hcloud FunctionGraph CancelAsyncInvocation | This API is used to stop asynchronous invocation of a function with N concurrent instances. |
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