okigan/awscurl

awscurl Docker镜像文档

镜像概述

awscurl是一个命令行工具，提供与curl相似的接口，用于向AWS服务发送经过AWS Signature Version 4签名的API请求。它自动化了AWS API请求的签名过程，使得与AWS服务的交互像使用标准curl命令一样简单，支持通过IAM配置文件凭证进行身份验证。

核心功能与特性

• AWS签名请求：自动对AWS API请求进行Signature Version 4签名，无需手动处理签名过程
• curl风格接口：提供与curl相似的命令行参数，降低使用门槛
• 凭证支持：支持通过命令行参数、环境变量或本地AWS凭证文件（~/.aws/credentials）提供访问凭证
• IAM配置文件支持：可使用IAM角色配置文件凭证进行身份验证
• 多服务支持：适用于S3、EC2、API Gateway等多种AWS服务

使用场景与适用范围

• 开发与测试环境中快速调用AWS API
• 自动化脚本中需要与AWS服务交互的场景
• 没有图形界面的环境下管理AWS资源
• 需要临时访问AWS服务且希望简化签名流程的场景

使用方法

拉取镜像

从Docker Hub拉取镜像：

bash
docker pull okigan/awscurl

或从GitHub容器注册表拉取：

bash
docker pull ghcr.io/okigan/awscurl

基本使用

使用命令行凭证

bash
docker run --rm -it okigan/awscurl \
  --access_key YOUR_ACCESS_KEY \
  --secret_key YOUR_SECRET_KEY \
  --service s3 \
  https://your-bucket.s3.amazonaws.com

使用本地AWS凭证

挂载本地AWS凭证目录（~/.aws）到容器中：

bash
docker run --rm -it -v "$HOME/.aws:/root/.aws" okigan/awscurl \
  --service s3 \
  https://your-bucket.s3.amazonaws.com

设置别名简化操作

为了简化命令，可创建别名：

bash
alias awscurl='docker run --rm -ti \
  -v "$HOME/.aws:/root/.aws" \
  -e AWS_ACCESS_KEY_ID \
  -e AWS_SECRET_ACCESS_KEY \
  -e AWS_SECURITY_TOKEN \
  -e AWS_PROFILE \
  okigan/awscurl'

之后可直接使用：

bash
awscurl --service s3 https://your-bucket.s3.amazonaws.com

使用示例

1. 调用S3服务：列出桶内容

bash
awscurl --service s3 https://awscurl-sample-bucket.s3.amazonaws.com | tidy -xml -iq

输出示例：

xml
<?xml version="1.0" encoding="utf-8"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Name>awscurl-sample-bucket</Name>
  <Prefix></Prefix>
  <Marker></Marker>
  <MaxKeys>1000</MaxKeys>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>awscurl-sample-file.txt</Key>
    <LastModified>2017-07-25T21:27:38.000Z</LastModified>
    <ETag>"d41d8cd98f00b204e9800998ecf8427e"</ETag>
    <Size>0</Size>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
</ListBucketResult>

2. 调用EC2服务：描述可用区域

bash
awscurl --service ec2 'https://ec2.amazonaws.com?Action=DescribeRegions&Version=2013-10-15' | tidy -xml -iq

输出示例：

xml
<?xml version="1.0" encoding="utf-8"?>
<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2013-10-15/">
  <requestId>96511ccd-2d6d-4d63-ad9b-6be6f2c9874d</requestId>
  <regionInfo>
    <item>
      <regionName>eu-north-1</regionName>
      <regionEndpoint>ec2.eu-north-1.amazonaws.com</regionEndpoint>
    </item>
    <item>
      <regionName>ap-south-1</regionName>
      <regionEndpoint>ec2.ap-south-1.amazonaws.com</regionEndpoint>
    </item>
  </regionInfo>
</DescribeRegionsResponse>

3. 调用API Gateway：发送POST请求

bash
awscurl --service execute-api -X POST -d @request.json \
  https://<prefix>.execute-api.us-east-1.amazonaws.com/<resource>

配置参数与选项

命令行参数

usage: awscurl [-h] [-v] [-i] [-X REQUEST] [-d DATA] [-H HEADER]
               [--region REGION] [--service SERVICE]
               [--profile AWS_PROFILE]
               [--access_key ACCESS_KEY] [--secret_key SECRET_KEY]
               [--security_token SECURITY_TOKEN]
               uri

位置参数

• uri: AWS API的请求URL

可选参数

• -h, --help: 显示帮助信息
• -v, --verbose: 启用详细输出模式
• -i, --include: 在响应中包含响应头
• -X REQUEST, --request REQUEST: 指定HTTP请求方法（默认：GET）
• -d DATA, --data DATA: HTTP POST数据
• -H HEADER, --header HEADER: 指定HTTP请求头
• --region REGION: AWS区域（默认：us-east-1）
• --service SERVICE: AWS服务名称（默认：execute-api）
• --profile PROFILE: AWS凭证配置文件（环境变量：AWS_PROFILE，默认：default）
• --access_key ACCESS_KEY: AWS访问密钥（环境变量：AWS_ACCESS_KEY_ID）
• --secret_key SECRET_KEY: AWS密钥（环境变量：AWS_SECRET_ACCESS_KEY）
• --security_token SECURITY_TOKEN: AWS安全令牌（环境变量：AWS_SECURITY_TOKEN）

凭证优先级

awscurl按以下顺序获取凭证：

1. 命令行参数（--access_key、--secret_key等）
2. 环境变量（AWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEY等）
3. 本地AWS凭证文件（~/.aws/credentials）中的指定配置文件（默认使用"default"配置文件）