Update README.md

This commit is contained in:
Zhong Lufan 2020-08-08 03:29:29 +08:00
parent 81b66f29e7
commit 4aae9598e0
No known key found for this signature in database
GPG Key ID: 373C08F7FFF84D26
1 changed files with 9 additions and 7 deletions

View File

@ -1,12 +1,12 @@
# Aliyun OpenAPI Shell SDK
这是一个非官方的阿里云 OpenAPI Shell SDK方便 Shell 脚本调用阿里云 OpenAPISDK 主要实现了自动计算请求签名。
这是一个非官方的阿里云 OpenAPI Shell SDK方便 Shell 脚本调用阿里云 OpenAPISDK 主要实现了自动计算 OpenAPI 的请求签名。
虽然阿里云官方有 [AliyunCLI](https://github.com/aliyun/aliyun-cli),可以在 Shell 环境下使用阿里云 OpenAPI不过某些 API (比如 SSL 证书) 它并不支持或者说还没来得及支持而且对于存储空间有限的嵌入式设备Shell SDK 明显是更好的选择。
理论上支持所有阿里云 RPC OpenAPI暂不支持 RESTful OpenAPI将来可能会支持。
> 这可能是最好用的 Aliyun Shell SDK
> 这可能是最好用的 Aliyun OpenAPI Shell SDK
## 依赖
@ -33,6 +33,7 @@ aliapi_rpc(host, http_method, api_version, api_action, api_custom_key[], api_cus
# 导出 AliAccessKeyId 和 AliAccessKeySecret
export AliAccessKeyId="<AliAccessKeyId>"
export AliAccessKeySecret="<AliAccessKeySecret>"
# 导入 SDK
source AliyunOpenApiSDK.sh
@ -40,10 +41,6 @@ source AliyunOpenApiSDK.sh
# 自定义值支持自定义函数,如果你需要包含空格或者读取文件等操作,可以声明一个自定义函数,像下面这样。
# 如果自定义值数组成员以 () 结尾SDK 在获取值的时候会判断自定义函数是否存在并执行,如果不存在则使用原始值。
get_show_size() {
echo 50
}
# 自定义请求参数的键
api_custom_key=(
"CurrentPage"
@ -54,6 +51,11 @@ api_custom_value=(
"1"
"get_show_size()" # 解析参数时会执行函数 (所以最后提交的值是 50)
)
get_show_size() {
echo 50
}
# 获取 SSL 证书列表https://help.aliyun.com/document_detail/126511.html
aliapi_rpc "cas.aliyuncs.com" "GET" "2018-07-13" "DescribeUserCertificateList" "${api_custom_key[*]}" "${api_custom_value[*]}"
# $? == 0 代表 HTTP CODE == 200 反之 $? == 1
@ -69,4 +71,4 @@ fi
如果你有好的示例,欢迎提交 [PR](https://github.com/Hill-98/aliyun-openapi-shell-sdk/pulls)
如果你有建议 / BUG 要反馈,也欢迎提交 [Issue](https://github.com/Hill-98/aliyun-openapi-shell-sdk/issues)
如果你有建议 / BUG 要反馈,提交 [Issue](https://github.com/Hill-98/aliyun-openapi-shell-sdk/issues)