Synchronizes the aggregation rule of a cluster to other clusters in a region.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| arms:SyncRecordingRules | none |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The ID of the cluster whose aggregation rule you want to synchronize. | cc7a37ee31aea4ed1a059eff8034b**** |
| TargetClusters | string | Yes | The IDs of clusters to which you want to synchronize the aggregation rule. | { "cn":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***" ], "us":[ "ce30f833bc4a04a56a06b070319***" ], "jp":[ ], "ap":[ ], "gov":[ ], "finance":[ ] } |
| RegionId | string | Yes | The ID of the region. The destination region can be the same as the source region. | cn-hangzhou |
Note: The TargetClusters parameter specifies the clusters to which aggregation rule is synchronized. You must pass the parameter in the JSON format. Each element in the TargetClusters parameter is an array, which indicates a cluster ID. Example: { "cn":[], //China "eu":[], //Europe "us":[], //America "jp":[], //Japan "ap":[], //Asia Pacific "gov":[], //Alibaba Gov Cloud "finance":[] //Alibaba Finance Cloud }. Enter cluster IDs in each pair of brackets ([]).
Response parameters
Note: If the value of the response parameter Data is true, the call is successful. Otherwise, the call fails. If the value of the data field is not null, the aggregation rule fails to be synchronized to some clusters. The error may occur due to cluster faults or request timeout. You need to check and troubleshoot the error before you call the API operation again.
Examples
Sample success responses
JSONformat
{
"RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
"Data": "{ \"data\":\\[ \"c06ca68cd16f14f52bb07772eda\\*\\*\\*\", \"c33dd70a0ac184c1b879d807ab2\\*\\*\\*\", \"c384cf7e4dcb543e6ac8c7d4dd3\\*\\*\\*\", \"ce30f833bc4a04a56a06b070319\\*\\*\\*\" ], \"message\":\"IDs of Clusters to which the aggregation rule failed to be synchronized\", \"success\":true }\n",
"Code": 200,
"Message": "success"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-03-20 | The response structure of the API has changed | View Change Details |
| 2022-09-02 | Add Operation | View Change Details |