V1 Replicators

URI

/replication/v1/replicators

HTTP 方法

GET

操作 ID：ListReplicators

列出复制器。

查询参数
名称	Type	必需	描述
`replicatorNameFilter`	String	False	返回以给定名称开头的 MSK 复制器。
`nextToken`	String	False	分页结果标记。当操作结果被截断时，调用将在响应中返回 `NextToken`。要获取下一批结果，请在下次请求中提供此令牌。
`maxResults`	String	False	要在响应中返回的最大结果数（默认情况下，每次 API 调用最多返回 100 个结果）。如果结果更多，则响应中包含 `NextToken` 参数。

响应
状态代码	响应模型	描述
`200`	`ListReplicatorsResponse`	HTTP 状态代码 200：OK。
`400`	None	请求无效，因为输入错误。请更正输入，然后重新提交。
`401`	None	请求未经授权。无法验证提供的凭证。
`403`	None	禁止访问。请检查凭证，然后重试请求。
`404`	None	由于输入错误，找不到资源。请更正输入，然后重试请求。
`429`	None	429 响应
`500`	None	出现意外内部服务器错误。重试请求可能会解决该问题。
`503`	None	503 响应

POST

操作 ID：CreateReplicator

创建复制器。

响应
状态代码	响应模型	描述
`200`	`CreateReplicatorResponse`	HTTP 状态代码 200：OK。
`400`	None	请求无效，因为输入错误。请更正输入，然后重新提交。
`401`	None	请求未经授权。无法验证提供的凭证。
`403`	None	禁止访问。请检查凭证，然后重试请求。
`404`	None	由于输入错误，找不到资源。请更正输入，然后重试请求。
`409`	None	此集群名称已存在。请使用其他名称重试请求。
`429`	None	429 响应
`500`	None	出现意外内部服务器错误。重试请求可能会解决该问题。
`503`	None	503 响应

OPTIONS

通过返回正确标头来启用 CORS

响应
状态代码	响应模型	描述
`200`	None	CORS 方法的默认响应

架构

请求正文


{
  "replicatorName": "string",
  "serviceExecutionRoleArn": "string",
  "replicationInfoList": [
    {
      "consumerGroupReplication": {
        "consumerGroupsToExclude": [
          "string"
        ],
        "detectAndCopyNewConsumerGroups": boolean,
        "consumerGroupsToReplicate": [
          "string"
        ],
        "synchroniseConsumerGroupOffsets": boolean
      },
      "targetCompressionType": enum,
      "topicReplication": {
        "copyAccessControlListsForTopics": boolean,
        "detectAndCopyNewTopics": boolean,
        "copyTopicConfigurations": boolean,
        "topicsToReplicate": [
          "string"
        ],
        "topicsToExclude": [
          "string"
        ]
      },
      "sourceKafkaClusterArn": "string",
      "targetKafkaClusterArn": "string"
    }
  ],
  "description": "string",
  "kafkaClusters": [
    {
      "amazonMskCluster": {
        "mskClusterArn": "string"
      },
      "vpcConfig": {
        "securityGroupIds": [
          "string"
        ],
        "subnetIds": [
          "string"
        ]
      }
    }
  ],
  "tags": {
  }
}

响应正文


{
  "nextToken": "string",
  "replicators": [
    {
      "replicatorArn": "string",
      "replicatorName": "string",
      "creationTime": "string",
      "kafkaClustersSummary": [
        {
          "kafkaClusterAlias": "string",
          "amazonMskCluster": {
            "mskClusterArn": "string"
          }
        }
      ],
      "replicatorState": enum,
      "isReplicatorReference": boolean,
      "replicationInfoSummaryList": [
        {
          "sourceKafkaClusterAlias": "string",
          "targetKafkaClusterAlias": "string"
        }
      ],
      "replicatorResourceArn": "string",
      "currentVersion": "string"
    }
  ]
}


{
  "replicatorArn": "string",
  "replicatorName": "string",
  "replicatorState": enum
}

属性

AmazonMskCluster

Amazon MSK 集群的详细信息。

属性	Type	必需	描述
`mskClusterArn`	字符串	True	Amazon MSK 集群的 Amazon 资源名称（ARN）。

ConsumerGroupReplication

有关使用器组复制的详细信息。

属性	Type	必需	描述
`consumerGroupsTo排除`	string 类型的数组 MaxLength：256	False	指定不应复制的使用器组的正则表达式模式列表。
`consumerGroupsTo复制`	string 类型的数组 MaxLength：256	True	表示要复制的使用器组的正则表达式模式列表。
`detectAndCopyNewConsumerGroups`	布尔值	False	启用使用器组与 MSK 复制器目标集群的同步。
`synchroniseConsumerGroup偏移量`	布尔值	False	启用使用器组偏移与 MSK 复制器目标集群的同步。转换后的偏移将写入主题 __consumer_offsets。

CreateReplicatorRequest

复制器的请求正文。

属性	Type	必需	描述
`description`	字符串 MaxLength：1024	False	复制器的摘要描述。
`kafkaClusters`	KafkaCluster 类型的数组	True	用于设置复制的源/目标的 Kafka 集群。
`replicationInfoList`	ReplicationInfo 类型的数组	True	复制配置列表，其中每个配置都以给定源集群到目标集群复制流程为目标。
`replicatorName`	字符串模式：`^[0-9A-Za-z][0-9A-Za-z-]{0,}$` MinLength: 1 MaxLength：128	True	复制器的名称。允许使用字母数字字符和“-”。
`serviceExecutionRoleArn`	字符串	True	复制器用于访问客户账户中资源（例如源集群和目标集群）的 IAM 角色的 Amazon 资源名称（ARN）
`tags`	object	False	要附加到已创建复制器的标签列表。

CreateReplicatorResponse

返回有关创建的 MSK 复制器的信息。

属性	Type	必需	描述
`ReplicatorArn`	字符串	False	MSK 复制器的 Amazon 资源名称（ARN）。
`replicatorName`	字符串	False	客户提供的 MSK 复制器的名称。
`replicatorState`	ReplicatorState	False	MSK 复制器的状态。

KafkaCluster

有关用作复制的源/目标的 Kafka 集群的信息。

属性	Type	必需	描述
`amazonMskCluster`	AmazonMskCluster	True	Amazon MSK 集群的详细信息。
`vpcConfig`	KafkaClusterClientVpcConfig	True	与 Apache Kafka 集群有网络连接的 Amazon VPC 的详细信息。

KafkaClusterClientVpcConfig

与 Kafka 集群有网络连接的 Amazon VPC 的详细信息。

属性	Type	必需	描述
`securityGroupIds`	string 类型的数组	False	要附加到代理节点的 ENI 的安全组。
`subnetIds`	string 类型的数组	True	客户端 VPC 中可连接到的子网列表。

KafkaClusterSummary

有关用作复制的源/目标的 Kafka 集群的摘要信息。

属性	Type	必需	描述
`amazonMskCluster`	AmazonMskCluster	False	Amazon MSK 集群的详细信息。
`kafkaClusterAlias`	字符串	False	Kafka 集群的别名。用于为已复制主题的名称添加前缀。

ListReplicatorsResponse

响应包含一个包含 MSK Replicator 信息的数组，以及响应 NextToken 是否被截断。

属性	Type	必需	描述
`nextToken`	字符串	False	如果的响应被截断， ListReplicators 则它会在响应 NextToken 中返回 a。这 NextToken 应在随后的请求中发送给 ListReplicators。
`replicators`	ReplicatorSummary 类型的数组	False	包含账户中每个 MSK 复制器的信息的列表。

ReplicationInfo

指定在 MSK 复制器源和目标 Kafka 集群之间复制的配置。

属性	Type	必需	描述
`consumerGroupReplication`	ConsumerGroupReplication	True	与使用器组复制相关的配置。
`sourceKafkaClusterArn`	字符串	True	MSK 复制器源 Kafka 集群的 Amazon 资源名称（ARN）。
`targetCompressionType`	TargetCompressionType	True	向 MSK 复制器目标集群生成记录时要使用的压缩类型。
`targetKafkaClusterArn`	字符串	True	MSK 复制器目标 Kafka 集群的 Amazon 资源名称（ARN）。
`topicReplication`	TopicReplication	True	与主题复制相关的配置。

ReplicationInfoSummary

集群间复制的摘要信息。

属性	Type	必需	描述
`sourceKafkaCluster别名`	字符串	False	MSK 复制器源 Kafka 集群的别名。
`targetKafkaCluster别名`	字符串	False	MSK 复制器目标 Kafka 集群的别名。

ReplicatorState

MSK 复制器的状态。

RUNNING
CREATING
UPDATING
DELETING
FAILED

ReplicatorSummary

有关 MSK 复制器的信息。

属性	Type	必需	描述
`creationTime`	字符串	False	创建 MSK 复制器的时间。
`currentVersion`	字符串	False	MSK 复制器当前版本。
`isReplicatorReference`	布尔值	False	表明此资源是否是 MSK 复制器引用。
`kafkaClustersSummary`	KafkaClusterSummary 类型的数组	False	用于设置复制的源/目标的 Kafka 集群。
`replicationInfoSummary清单`	ReplicationInfoSummary 类型的数组	False	集群间复制的摘要信息列表。
`ReplicatorArn`	字符串	False	MSK 复制器的 Amazon 资源名称（ARN）。
`replicatorName`	字符串	False	MSK 复制器的名称。
`replicatorResourceArn`	字符串	False	创建复制器的区域中 MSK 复制器资源的 Amazon 资源名称（ARN）。
`replicatorState`	ReplicatorState	False	MSK 复制器的状态。

TargetCompressionType

向目标集群生成记录时要使用的压缩类型。

NONE
GZIP
SNAPPY
LZ4
ZSTD

TopicReplication

有关主题复制的详细信息。

属性	Type	必需	描述
`copyAccessControlListsForTopics`	布尔值	False	是否定期配置远程主题 ACL 以匹配其对应的上游主题。
`copyTopicConfigurations`	布尔值	False	是否定期配置远程主题以匹配其对应的上游主题。
`detectAndCopyNewTopics`	布尔值	False	是否定期检查新主题和分区。
`topicsToExclude`	string 类型的数组 MaxLength: 249	False	指定不应复制的主题的正则表达式模式列表。
`topicsToReplicate`	string 类型的数组 MaxLength: 249	True	指定要复制的主题的正则表达式模式列表。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

MSK 复制器的 API 资源

V1 Replicators replicatorArn