[Unofficial] Alibaba Cloud SDK for Bash
Go to file
Zhong Lufan 3c2942b31c
Add _aliapi_check_vars helper function
2022-06-20 01:57:10 +08:00
.github/workflows Update github actions 2022-06-20 00:32:35 +08:00
examples Use bash built-in method to convert case 2022-06-20 01:01:06 +08:00
.editorconfig Add bats test 2022-06-20 00:13:38 +08:00
.gitattributes Update 2019-12-31 23:36:16 +08:00
.gitignore Add bats test 2022-06-20 00:13:38 +08:00
AliyunOpenApiSDK.sh Add _aliapi_check_vars helper function 2022-06-20 01:57:10 +08:00
LICENSE Update LICENSE 2022-06-20 00:13:38 +08:00
README.md Update README.md 2022-06-20 00:41:15 +08:00
test.bats.sh Add _aliapi_check_vars helper function 2022-06-20 01:57:10 +08:00

README.md

Aliyun OpenAPI Bash SDK

这是一个非官方的阿里云 OpenAPI Bash SDK方便 Bash 脚本调用阿里云 OpenAPISDK 主要实现了自动计算 OpenAPI 的请求签名。

理论上支持所有阿里云 RPC OpenAPI暂不支持 RESTful OpenAPI将来可能会支持。

这可能是最好用的 Aliyun OpenAPI Bash SDK

依赖

  • curl
  • openssl

使用

  1. 声明变量 AliAccessKeyIdAliAccessKeySecret
  2. 导入 AliyunOpenApiSDK.sh
  3. 调用 aliapi_rpc 函数

函数签名:

# Output: JsonString
# Retrun Code: 0 = HTTP_STATUS_CODE == 200 | 1 = HTTP_STATUS_CODE != 200
aliapi_rpc <http_method> <host> <api_version> <api_action> [<--key> <value>...]

PS: AliyunOpenApiSDK.sh 支持作为脚本独立执行,脚本参数与函数参数一致,作为脚本运行时,AliAccessKeyIdAliAccessKeySecret 变量需要导出。

示例:

#!/usr/bin/env bash

# 设置 AliAccessKeyId 和 AliAccessKeySecret
AliAccessKeyId="<AliAccessKeyId>"
AliAccessKeySecret="<AliAccessKeySecret>"

# 导入 SDK
source AliyunOpenApiSDK.sh

# 如果值以 () 结尾,那么 SDK 会假设它是一个已定义函数,获取值时会判断函数是否存在并执行,如果不存在则使用原始值。

get_show_size() {
    echo 50
}

# 获取 SSL 证书列表https://help.aliyun.com/document_detail/126511.html
# 解析参数时会执行函数 (所以 ShowSize 的值是 50)
aliapi_rpc GET cas.aliyuncs.com 2018-07-13 DescribeUserCertificateList --CurrentPage 1 --ShowSize "get_show_size()"
# $? == 0 代表 HTTP CODE == 200 反之 $? == 1
# 只要 curl 的退出代码 == 0 就会返回接收到的数据
if [[ $? -eq 0 ]]; then
    # 执行成功
else
    # 执行失败
fi

更多示例请参考 examples 下的文件

如果你有好的示例,欢迎提交 PR