InvokeAWSGatewayApi
描述:
调用AWS云网关API
标签:
Amazon, AWS, Client, Gateway-API, Rest, http, https, 客户端, 云网关, 调用, 请求
参数:
如下列表中，必填参数则标识为加粗. 其他未加粗参数，则表示为可选参数。表中同时提到参数默认值设置, 参数还支持 表达式语言, 并且 如果将一个参数认定为"敏感", 表示是加密状态. 在输入一个敏感参数时, 确保 orchsym.properties 文件中存在属性设置 orchsym.sensitive.props.key.
| 名字 | 默认值 | 允许值列表 | 描述 |
|---|---|---|---|
| HTTP 方法 | GET | HTTP 请求方法 (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS).除了POST, PUT 以及 PATCH的方法将不发送消息体 支持表达式语言 (支持流属性和变量) | |
| 地区 | 美国西部 (俄勒冈) | - 亚马逊政府云 (美国) - 美国东部 (弗吉尼亚) - 美国东部 (俄亥俄州) - 美国西部 (加利福尼) - 美国西部 (俄勒冈) - 欧洲 (爱尔兰) - 欧洲 (伦敦) - 欧洲 (巴黎) - 欧洲 (法兰克福) - 亚太 (孟买) - 亚太 (新加坡) - 亚太 (悉尼) - 亚太 (东京) - 亚太 (首尔) - 南美 (圣保罗) - 中国 (北京) - 中国 (宁夏) - 加拿大 (中部) | 指定地区区域名 |
| AccessKey访问秘钥 | 指定AWS的AccessKey访问秘钥 敏感状态 支持表达式语言 (仅支持变量) | ||
| SecretKey秘钥 | 指定AWS的SecretKey秘钥 敏感状态 支持表达式语言 (仅支持变量) | ||
| 证书文件 | 指定包含AWSAccessKey访问秘钥和SecretKey秘钥的证书属性文件路径 | ||
| AWS证书提供服务 | 控制器服务API: AWSCredentialsProviderService 实现: AWSCredentialsProviderControllerService | 用于提供AWS证书的服务 | |
| 通信超时 | 30 secs | 指定连接通信超时时间 | |
| 云网关资源名 | 指定云网关API资源名字 | ||
| API Endpoint | 指定云网关访问API的Endpoint | ||
| API Key | 指定云网关访问的API Key 敏感状态 支持表达式语言 (支持流属性和变量) | ||
| 匹配属性发送 | 通过正则匹配的输入数据流属性将作为HTTP头一并发送。如果不指定，则没有任何属性将作为HTTP头发送。同时，动态参数设置也将作为HTTP头发送。 | ||
| 响应Body作为属性 | 如果设置，响应接收到的Body将作为原始输入数据流的属性输出，而不是将Body单独作为数据流输出。 支持表达式语言 (支持流属性和变量) | ||
| Content-Type | ${mime.type} | 当通过PUT, POST 或 PATCH方法传输时，指定内容的Content-Type。如果值为空，则默认为application/octet-stream 支持表达式语言 (未定义) | |
| 发送消息Body | 发送 | - 发送 - 不发送 | 如果发送，则当请求是POST/PUT/PATCH时发送消息Body。如果不发送，则禁止在请求中发送消息Body和Content-type头 |
| 总是输出响应 | 不输出 | - 输出 - 不输出 | 指定是否强制生成响应数据流输出到“Response”连线，而不管接收到的服务器状态代码是什么，或者处理器是否配置为将服务器响应主体置于请求属性中。在后面的配置中，一个请求数据流（响应Body在属性中）和一个典型的响应数据流将被发送到它们各自的连线中。 |
| 惩罚到 "No Retry" | 禁用 | - 启用 - 禁用 | 启用该参数则将惩罚输出到"No Retry"连线 |
| 代理主机 | 指定代理主机名或IP 支持表达式语言 (仅支持变量) | ||
| 代理端口号 | 指定代理端口号 支持表达式语言 (仅支持变量) | ||
| 代理用户名 | 指定代理访问的用户名 支持表达式语言 (未定义) | ||
| 代理用户密码 | 指定代理访问的用户密码 敏感状态 支持表达式语言 (未定义) | ||
| 查询参数 | 指定请求查询参数，通过“名字=值”指定，连接多个参数通过“&”连接 支持表达式语言 (支持流属性和变量) | ||
| 最大属性 | 256 | 如果将响应Body作为属性输出(通过设置“响应Body作为属性”参数或接收到错误状态码), 放入属性值的字符数最多为这个数量。 这一点很重要，因为属性保存在内存中，而较大的属性会很快导致内存不足问题。如果输出长于此值，它将被截断以适合。如果可以的话，可以考虑减少该值。 | |
| 添加响应头请求 | 禁用 | - 启用 - 禁用 | 启用此属性将保存原始请求的所有响应头。这可能适用于在需要响应头但由于仅收到的状态码而没有生成响应时。 |
| 代理配置 | 控制器服务API: ProxyConfigurationService 实现: StandardProxyConfigurationService | 当需要通过代理请求时，指定代理配置服务。如果设置，它将取代每个组件配置的代理设置。支持的代理：HTTP+AuthN |
动态参数:
| 名字 | 值 | 描述 |
|---|---|---|
| Header Name | Attribute Expression Language | 通过动态参数方式添加自定义的请求头 不支持表达式语言 |
连线:
| 名字 | 描述 |
|---|---|
| Original | 请求成功后，输出原始输入数据流 (2xx 状态码). 且将具有新属性来详细说明请求成功 |
| Failure | 任何连接失败、超时或异常情况，原始输入数据流将输出到该失败连线。且具有新属性来详细描述请求问题 |
| Retry | 当可以重试（5xx 状态码）时，原始输入数据流将输出到该连线。且具有新属性来详细描述请求问题 |
| No Retry | 由于请求返回状态码为不可重试（1xx, 3xx, 4xx 状态码）时，原始输入数据流将输出到该连线。且具有新属性来详细描述请求问题 |
| Response | 请求成功(2xx 状态码)后，将输出响应数据流到该连线。 |
读取属性:
未提供。
写入属性:
| 名字 | 描述 |
|---|---|
| mime.type | 数据流文件的MIME类型 |
| aws.gateway.api.status.code | 返回的状态码 |
| aws.gateway.api.status.message | 返回的状态信息 |
| aws.gateway.api.response.body | 响应Body (2xx) |
| aws.gateway.api.resource | 请求资源 |
| aws.gateway.api.tx.id | 读取响应后返回的事务ID |
| aws.gateway.api.java.exception.class | 当组件失败时的Java异常类 |
| aws.gateway.api.java.exception.message | 当组件失败时的Java异常消息 |
状态管理:
该组件不保存状态。
限制:
该组件没有限制
输入流要求:
组件允许提供输入流。
系统资源考量:
未提供。