72 lines
2.7 KiB
Markdown
72 lines
2.7 KiB
Markdown
# Aliyun OpenAPI Bash SDK
|
||
|
||
[](https://github.com/Hill-98/aliyun-openapi-bash-sdk/actions/workflows/bats-test.yml)
|
||
|
||
这是一个非官方的阿里云 OpenAPI Bash SDK，用于 Bash 脚本调用阿里云 OpenAPI，相较于 [aliyun-cli](https://github.com/aliyun/aliyun-cli) 更加轻量，适合小存储设备。
|
||
|
||
理论上支持所有阿里云 RPC OpenAPI，暂不支持 RESTful OpenAPI，将来可能会支持。
|
||
|
||
> 这可能是最好用的 Aliyun OpenAPI Bash SDK
|
||
|
||
## 依赖
|
||
|
||
* coreutils (`date`) # 获取时间戳
|
||
* curl # 网络请求
|
||
* openssl # 计算 HAMC-SHA1 签名
|
||
|
||
### 可选依赖
|
||
|
||
* ldd # 检查当前 Shell 是否使用 musl libc
|
||
* coreutils (`grep`) # 检查当前 Shell 是否使用 musl libc
|
||
|
||
> 由于 glibc 和 musl libc 之间的差异，SDK 内部针对这两个不同的库做了些处理，初始化时使用 ldd 检查当前 Shell 是否使用了 musl libc。
|
||
> 如果需要跳过检查，可以在导入之前设置变量: `ALIYUN_SDK_RUN_ON_MUSL_LIBC`，`1` 表示使用了 musl libc，`0` 表示没有使用。
|
||
|
||
## 使用
|
||
|
||
1. 声明变量 `AliAccessKeyId` 和 `AliAccessKeySecret`
|
||
2. 导入 `AliyunOpenApiSDK.sh`
|
||
3. 调用 `aliapi_rpc` 函数
|
||
|
||
函数签名：
|
||
```bash
|
||
# Output: JsonString
|
||
# Retrun Code: 0 = ALIYUN_SDK_LAST_HTTP_CODE == 200 | 1 = ALIYUN_SDK_LAST_HTTP_CODE != 200
|
||
aliapi_rpc <http_method> <host> <api_version> <api_action> [<--key> <value>...]
|
||
```
|
||
|
||
`AliyunOpenApiSDK.sh` 可以作为脚本使用，脚本第一个参数为 `--rpc`，剩余参数为 `aliapi_rpc` 可接受参数。作为脚本使用时，`AliAccessKeyId` 和 `AliAccessKeySecret` 变量需要 `export`。
|
||
|
||
**示例：**
|
||
|
||
```bash
|
||
#!/usr/bin/env bash
|
||
|
||
# 设置 AliAccessKeyId 和 AliAccessKeySecret
|
||
AliAccessKeyId="<AliAccessKeyId>"
|
||
AliAccessKeySecret="<AliAccessKeySecret>"
|
||
|
||
# 导入 SDK
|
||
source AliyunOpenApiSDK.sh
|
||
|
||
get_show_size() {
|
||
echo 50
|
||
}
|
||
|
||
# 获取 SSL 证书列表：https://help.aliyun.com/document_detail/126511.html
|
||
# 如果值以 () 结尾，那么 SDK 会假设它是一个函数，获取值时会判断函数是否存在并执行。
|
||
# 如果不存在则使用原始值，所以这里 ShowSize 的值是 50。
|
||
aliapi_rpc GET cas.aliyuncs.com 2018-07-13 DescribeUserCertificateList --CurrentPage 1 --ShowSize "get_show_size()"
|
||
# 如果 HTTP 状态码是 200，那么返回代码是 0，否则返回代码为 1。
|
||
# 使用 ALIYUN_SDK_LAST_HTTP_CODE 变量可以获取最后一次调用的 HTTP 状态码。
|
||
if [[ $? -eq 0 ]]; then
|
||
# 执行成功
|
||
else
|
||
# 执行失败
|
||
fi
|
||
```
|
||
|
||
更多示例请参考 [examples](/examples) 下的文件
|
||
|
||
如果你有好的示例，欢迎提交 [PR](https://github.com/Hill-98/aliyun-openapi-bash-sdk/pulls)。
|