getParametersByPath 页面大小 1. AWS 服务器端 SSM API2.分页3. API 限制4.可能的解决方法参考资料

问题描述

在 AWS-SDK for Node.js getParametersByPath() 中,SSM 方法返回分页数据,这意味着我必须在循环中进行多次调用。有没有办法禁用分页增加页面大小(超过 10,这是 Maxnumber 参数的最大值)?

或者,如果必须进行多次调用 - 是否可以将结果收集到 Promise 数组中以立即解决

基本上,我们需要在 Lambda 启动时加载大约 12 个参数。当前获取参数大约需要 2 秒 - 因为进行了 2 个连续调用。理想情况下,它必须是 1 个调用或 2 个并行调用

解决方法

这是个好问题。让我概述一些概念、AWS 设计决策以及我将如何解决它们施加的限制。

1. AWS 服务器端 SSM API

所有 AWS 客户端 SDK,包括适用于 Node.js 的 AWS-SDK,都会对相应 AWS 服务的 REST API 进行 API 调用,例如AWS Systems Manager 端点 [1] 的 API 操作 GetParametersByPath

2.分页

AWS API 通常实现所谓的基于光标的分页概念。这种类型的分页除了基于页面的分页(即经典的偏移限制分页)之外还有其他特征 - 在一些 Medium 文章 [2][3] 中进行了描述。

基于游标的分页的一个主要限制是:它不允许发送不同批次的并行请求。无法跳转到特定页面,它需要遍历所有前几页。

查看每种分页类型的优缺点后,AWS 工程师可能会以性能为代价做出取舍,以支持一致性

3. API 限制

AWS 声明 MaxResults 参数的有效范围是 1-10。这意味着,客户端无法将页面大小扩展到 10 以上。所有 SDK 在实现分页时都必须遵守该限制。禁用分页 [4] 的唯一效果是返回最多 10 个项目的单页。

4.可能的解决方法

  1. 您可以将 SSM API 结果同步到自定义 DynamoDB 表并查询 DynamoDB 而不是 SSM。该解决方案是否可行取决于几个特征,例如一致性要求、SSM 参数更改的频率以及 SSM 参数值的机密性(或 Lambda 函数读取哪些参数属性)。

  2. 如果正确拆分预期结果集并使用 ParameterFilters API 参数 [1],则可以向 API 发送并发请求。您可以通过以下键进行拆分:tag:.+|Name|Type|KeyId|Path|Label|Tier|DataType 使用 BeginsWithEquals 选项。 [5]

    此解决方案要求您可以对预期收到的结果进行假设。您必须确保特定子集包含的条目不超过 10 个。如果有例如最大限度。每个部门 10 个 SSM 参数,您可以执行以下操作:通过每个部门的 getParametersByPath() 发送一个请求,指定 MaxResults=10Path=/department/<name>ParameterFilters=[{Key=tag:department,Option=Equals,Values=["<name>"]}]。这些部门特定的请求可以同时发送。

解决方法 2 可以被视为您在问题中提到的“两个并发请求”方法,而解决方法 1 是“一个单一请求”方法。变通方法需要删除一致性属性或对数据分区做出假设。

参考资料

[1] https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParametersByPath.html#systemsmanager-GetParametersByPath-request-NextToken
[2] https://medium.com/innomizetech/how-to-build-an-api-with-aws-lambda-to-paginate-data-using-serverless-41c4b6b676a4
[3] https://medium.com/swlh/paginating-requests-in-apis-d4883d4c1c4c
[4] https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-pagination.html#cli-usage-pagination-serverside
[5] https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_ParameterStringFilter.html#systemsmanager-Type-ParameterStringFilter-Option

,

我要给你一个简单的答案和一个我已经解决了好几次的问题:

或者,如果必须进行多次调用 - 是否可以将结果收集到 Promise 数组中以立即解决?

是的,方法如下 -

const { SSM } = require('aws-sdk');
const ssm = new SSM();

function getSSMStuff(path,memo = [],nextToken) {
  return ssm
.getParametersByPath({ Path: path,WithDecryption: true,Recursive: true,NextToken: nextToken,MaxResults: 10 })
.promise()
.then(({ Parameters,NextToken }) => {
  const newMemo = memo.concat(Parameters);
  return NextToken ? getSSMStuff(path,newMemo,NextToken) : newMemo;
});
}

如果您使用路径调用它,它将递归调用自身以获取该路径中的所有参数,最终解析为完整参数的数组。显然,您应该自行处理错误,但这就是要点。