将某个集群的聚合规则批量同步到全Region的其他目标集群。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:SyncRecordingRules | none |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 被同步的集群 ID。 | cc7a37ee31aea4ed1a059eff8034b**** |
| TargetClusters | string | 是 | 批量的目标集群 ID 内容。 | { "cn":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***" ], "us":[ "ce30f833bc4a04a56a06b070319***" ], "jp":[ ], "ap":[ ], "gov":[ ], "finance":[ ] } |
| RegionId | string | 是 | 地域 ID。（可以和被同步集群所属的 RegionId 一致） | cn-hangzhou |
注意：TargetClusters 参数是用于批量同步目标集群的内容设定，需要严格根据定义的参数格式传参；其是一个 JSON 格式对象，对象中的每个元素是一个数组，用户可以在对应的元素中添加对应的集群 ID；下面是特定的参数格式及每个元素代表的区域说明（需要将目标集群 ID 填入对应的区域数组元素中）： { "cn":[], //中国 "eu":[], //欧洲 "us":[], //美洲 "jp":[], //日本 "ap":[], //亚太 "gov":[], //政务云 "finance":[] //金融云 }
返回参数
注意：返参 Data 中，若 success 为 true，则表明此次调用成功，否则调用失败；若 data 内容不为空，则表明此次调用中存在设置失败的目标集群，失败原因或许和集群自身或和网络请求超时有关，需要自行查看核实，或者将失败集群归类后再次调用。
示例
正常返回示例
JSON格式
{
"RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
"Data": "{ \"data\":[ \"c06ca68cd16f14f52bb07772eda***\", \"c33dd70a0ac184c1b879d807ab2***\", \"c384cf7e4dcb543e6ac8c7d4dd3***\", \"ce30f833bc4a04a56a06b070319***\" ], \"message\":\"设置RecordingRule失败的clusterIds\", \"success\":true }",
"Code": 200,
"Message": "success"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-09-02 | 新增 OpenAPI | 查看变更详情 |