更新时间:2024-12-16 GMT+08:00
分享

通过KooCLI管理函数

KooCLI工具支持FunctionGraph服务,用户可以通过CLI工具执行函数管理,别名管理,触发器管理函数调用等操作。

获取CLI工具

CLI工具支持64位的Linux x86系统及64位Windows系统,以及Mac系统,具体下载地址如表1所示。

表1 下载地址

系统

软件包及校验文件

参考文档

Linux

各系统类型软件包及校验文件下载请参见CLI软件和校验文件下载

KooCLI介绍

Windows

Mac

  • 当通过API访问公有云系统时,需要使用访问密钥(AK/SK)进行身份认证并对请求进行加密,确保请求的机密性、完整性和请求双方身份的正确性。请妥善保存config.yaml配置文件,确保访问密钥不被非法使用。
  • 当发现访问密钥被非法使用(包括丢失、泄露等情况),可以自行删除或者通知管理员重置访问密钥,重新配置。
  • 删除的访问密钥将无法恢复。

安装KooCLI命令行工具

  1. 安装KooCLI命令行工具,请参见在Linux系统上安装KooCLI
  2. 获取访问密钥(Access Key ID和Secret Access key)
    • 如果您有登录密码,可以登录控制台,可以在我的凭证中获取自己的访问密钥AK/SK。请参见:新增访问密钥。可以下载得到AK/SK文件,文件名一般为:credentials.csv。如下图所示,文件包含了用户名称(User Name),AK(Access Key Id),SK(Secret Access Key)。
      图1 credentials.csv文件内容
    • 如果您没有登录密码,不能登录控制台,在访问密钥异常丢失或者需要重置时,可以请账号管理员在IAM中生成您的访问密钥,并发送给您。请参见:管理IAM用户访问密钥
  3. 获取Region Name,请参见:地区和终端节点
    图2 获取区域
  4. 初始化KooCLI命令行工具

    执行如下命令初始化KooCLI命令行工具:

    hcloud configure init

    需要输入Access Key ID、Secret Access key和Region Name,初始化成功如图3所示。

    图3 初始化成功
  5. 执行如下命令,查看FunctionGraph支持命令。如图4所示,“Available Operations”中返回了FunctionGraph服务支持的operation列表。
    hcloud FunctionGraph --help
    图4 FunctionGraph服务支持的operation列表

    执行如下命令,查看“调用函数”操作的帮助信息。如图5所示,返回如下信息。

    hcloud FunctionGraph InvokeFunction --help
    图5 “调用函数”操作的帮助信息

函数调用

调用函数首先需要获取函数的urn,如图6所示。

图6 获取函数URN
  • 同步调用

    执行同步调用示例命令,参数说明请参见表1

    hcloud FunctionGraph InvokeFunction --cli-region="ap-southeast-1" --X-Cff-Log-Type="tail" --X-CFF-Request-Version="v1" --function_urn="urn:fss:cn-east-3:******:function:default:hcloud-invoke:latest" --project_id="******" --key="value"
    表2 参数说明

    参数

    是否必须

    描述

    --cli-region

    调用函数所在region。

    --function_urn

    函数的URN(Uniform Resource Name),唯一标识函数。

    --project_id

    租户Project ID。

    --X-Cff-Log-Type

    tail(header里面返回函数执行后的4K日志),或者为空(不返回日志)。

    X-CFF-Request-Version

    返回体格式:取值v0,v1。

    • v0:默认返回文本格式。
    • v1:默认返回json格式,sdk需要使用此值。

    Body

    通过--key="value"方式指定请求体,其对应的json结构:{ "key":"value"}。

    输出结果如图2所示,输出的响应参数请参见表2

    图7 输出结果
    表3 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求ID

    result

    String

    函数执行结果

    log

    String

    函数执行返回日志

    status

    Integer

    函数执行返回状态

    error_code

    String

    错误码

  • 异步调用

    执行异步调用示例命令,参数说明请参见表3

    hcloud FunctionGraph AsyncInvokeFunction --cli-region="cn-east-3" --function_urn="urn:fss:cn-east-3:******:function:default:hcloud-invoke:latest" --project_id="******" --key="value"
    表4 参数说明

    参数

    是否必须

    描述

    --cli-region

    调用函数所在region。

    --function_urn

    函数的URN(Uniform Resource Name),唯一标识函数。

    --project_id

    租户Project ID。

    请求体

    通过--key="value"方式指定请求体,其对应的json结构:{ "key":"value"}。

    输出结果如图3所示,输出的响应参数请参见表2

    图8 输出结果
    表5 响应参数说明

    参数

    参数类型

    描述

    request_id

    String

    请求ID

相关文档