Update README.md

This commit is contained in:
Zhong Lufan 2023-12-05 03:07:45 +08:00 committed by GitHub
parent 823588b579
commit e101aca5a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 10 deletions

View File

@ -19,8 +19,8 @@
* ldd # 检查当前 Shell 是否使用 musl libc
* coreutils (`grep`) # 检查当前 Shell 是否使用 musl libc
> 由于 glibc 和 musl libc 之间的差异SDK 内部针对这两个不同的库做了些处理,SDK 导入时会使用 ldd 对当前 Shell 进行检查,判断是否使用了 musl libc。
> 如果需要跳过检查,可以在导入 SDK 之前设置 `ALIYUN_SDK_RUN_ON_MUSL_LIBC` 变量`1` 表示使用了 musl libc`0` 表示没有使用。
> 由于 glibc 和 musl libc 之间的差异SDK 内部针对这两个不同的库做了些处理,初始化时使用 ldd 检查当前 Shell 是否使用了 musl libc。
> 如果需要跳过检查,可以在导入之前设置变量: `ALIYUN_SDK_RUN_ON_MUSL_LIBC``1` 表示使用了 musl libc`0` 表示没有使用。
## 使用
@ -31,11 +31,11 @@
函数签名:
```bash
# Output: JsonString
# Retrun Code: 0 = HTTP_STATUS_CODE == 200 | 1 = HTTP_STATUS_CODE != 200
# 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`
`AliyunOpenApiSDK.sh` 可以作为脚本执行,脚本第一个参数为 `--rpc`,剩余参数为 `aliapi_rpc` 可接受参数。作为脚本运行时,`AliAccessKeyId` 和 `AliAccessKeySecret` 变量需要导出
**示例:**
@ -49,17 +49,15 @@ AliAccessKeySecret="<AliAccessKeySecret>"
# 导入 SDK
source AliyunOpenApiSDK.sh
# 如果值以 () 结尾,那么 SDK 会假设它是一个已定义函数,获取值时会判断函数是否存在并执行,如果不存在则使用原始值。
get_show_size() {
echo 50
}
# 获取 SSL 证书列表https://help.aliyun.com/document_detail/126511.html
# 解析参数时会执行函数 (所以 ShowSize 的值是 50)
# 如果值以 () 结尾,那么 SDK 会假设它是一个函数,获取值时会判断函数是否存在并执行,如果不存在则使用原始值,所以这里 ShowSize 的值是 50。
aliapi_rpc GET cas.aliyuncs.com 2018-07-13 DescribeUserCertificateList --CurrentPage 1 --ShowSize "get_show_size()"
# $? == 0 代表 HTTP CODE == 200 反之 $? == 1
# 可以使用 ALIYUN_SDK_LAST_HTTP_CODE 变量获取最后一次的 HTTP CODE
# 如果 HTTP 状态码是 200那么返回代码是 0否则返回代码为 1。
# 使用 ALIYUN_SDK_LAST_HTTP_CODE 变量可以获取最后一次调用的 HTTP 状态码。
if [[ $? -eq 0 ]]; then
# 执行成功
else
@ -67,6 +65,6 @@ else
fi
```
更多示例请参考 [examples](https://github.com/Hill-98/aliyun-openapi-bash-sdk/tree/master/examples) 下的文件
更多示例请参考 [examples](/examples) 下的文件
如果你有好的示例,欢迎提交 [PR](https://github.com/Hill-98/aliyun-openapi-bash-sdk/pulls)。