同步集群內實例數據。
接口說明
-
只有中國內地密碼機實例支持此接口。
-
同步集群預計需要 5 分鐘，請在業務空閑期進行同步，以免影響業務運行。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| yundun-hsm:SyncCluster | update | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID。 | cluster-BqxX63Bsgytet**** |
返回參數
示例
正常返回示例
JSON格式
{
"Job": {
"Completed": true,
"CreateTime": "1711764127000",
"Error": "OperationTimeout",
"JobId": "job-000bu7m5vjmyz9s7qz85",
"Progress": 90,
"Response": "success",
"Status": "success",
"Type": "create"
},
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | SwitchMaster.InstanceInvalid | Instance not in the cluster. | - |
| 400 | LeaveCluster.MasterLast | Master instance can not leave a cluster until all other instances are left. | - |
| 400 | Certificate.ChainInvalid | Certificate chain invalid. Please make sure issuer certificate is the trust anchor and cluster certificate is signed by issuer certificate. | - |
| 400 | Certificate.FormatInvalid | Certificate format invalid. Cluster/Issuer certificate must be in PEM format. | - |
| 400 | ConfigClusterSubnet.DuplicateZone | VSwitches should not contain duplicate zones. | - |
| 400 | InvalidApiParam.Error | api param is invalid | - |
| 400 | InvalidClusterName | Invalid parameter clusterName. | - |
| 400 | InvalidPageSize | Invalid parameter pageSize. | - |
| 400 | InvalidCurrentPage | Invalid parameter currentPage. | - |
| 400 | InvalidRegionId | Invalid parameter regionId. | - |
| 400 | InvalidVSwitch | Invalid parameter vSwitch. | - |
| 400 | InvalidVpc | Invalid parameter vpcId. | - |
| 400 | InvalidIp | Invalid parameter IP. | - |
| 400 | InvalidAliuid | Invalid parameter aliuid. | - |
| 400 | InvalidClusterId | Invalid parameter clusterId. | - |
| 400 | InvalidInstanceId | Invalid parameter instanceId. | - |
| 400 | InvalidBackupId | Invalid parameter backupId. | - |
| 400 | InvalidImageId | Invalid parameter imageId. | - |
| 400 | HsmInstanceNotExist.Error | hsm instance not exist | - |
| 400 | HSMIntanceNotActived.Error | hsm intance is not actived | - |
| 400 | WhiteListMaxCount.Error | whilte list is more than max count | - |
| 400 | ClusterIdIsNotExists.Error | cluster ID non-exists | - |
| 400 | InstanceListIsEmpty.Error | instance list is empty | - |
| 400 | InstanceIdIsEmpty.Error | instance id is empty | - |
| 400 | InstanceIsNotExistsInCluster.Error | cluster has no such instance | - |
| 400 | InstanceIsExistsInCluster.Error | instance already in the cluster | - |
| 400 | RegionNoEmpty.Error | region no. is empty | - |
| 400 | ClusterNameEmpty.Error | empty cluster name not allowed | - |
| 400 | ClusterNameIsExists.Error | the cluster name is already taken | - |
| 400 | IpNotValid.Error | ip not valid | - |
| 400 | ClusterIsEmpty.Error | cluster is empty | - |
| 400 | NoMasterFoundInCluster.Error | cluster has no master instance | - |
| 400 | HsmInstanceIdNotFound.Error | no such instance | - |
| 400 | NoInstanceFoundInCluster.Error | cluster is empty | - |
| 400 | Whitelist.Invalid | Whitelist blocks not in CIDR format. | - |
| 400 | Whitelist.TooLong | Whitelist too long, exceeds 10 CIDR blocks. | - |
| 403 | NoPermission | Caller has no permission on the resource. | - |
| 403 | InstanceNotPaused | Please pause the instance before reset. | - |
| 403 | InstanceNotActive | Instance is not active. | - |
| 403 | ConfigIp.IncorrectState | Instance not in pending or active state, can not config IP address. | - |
| 403 | SwitchMaster.IncorrectState | Cluster not initialized, please initialize the cluster first. | - |
| 403 | SyncCluster.IncorrectState | Cluster not initialized, please initialize the cluster first. | - |
| 403 | LeaveCluster.InstanceInvalid | The instance is not in the cluster. | - |
| 403 | DeleteCluster.IncorrectState | Cluster not empty, please remove all instances first. | - |
| 403 | JoinCluster.InstanceVSwitchNotInCluster | Instance's vSwitch is not in cluster config, please change instance's vSwitch first. | - |
| 403 | JoinCluster.InstanceInitialized | Initialized instance can not join a cluster. | - |
| 403 | JoinCluster.IncorrectState | Cluster not initialized, please initialize the cluster first. | - |
| 403 | InitializeCluster.InstanceNotInitialized | Cluster master instance not initialized, please initialize cluster master instance first. | - |
| 403 | InitializeCluster.IncorrectConfig | Cluster subnet not configured, please config cluster subnet first. | - |
| 403 | InitializeCluster.IncorrectState | Cluster initialized, do not re-initialize. | - |
| 403 | Cluster.CN.ActionForbidden | This API is forbidden for non-international site cluster. | - |
| 403 | Cluster.INTL.ActionForbidden | This API is forbidden for international site cluster. | - |
| 403 | ConfigClusterCertificate.IncorrectState | Cluster initialized or certificates already configured. | - |
| 403 | ConfigClusterSubnet.InvalidVpcId | VPC Id invalid. Cluster VPC is the same as cluster master's VPC. | - |
| 403 | ConfigClusterSubnet.InvalidVSwitchId | VSwitch Id invalid. VSwitches should contain all current cluster vSwitches. | - |
| 403 | ConfigClusterSubnet.IncorrectState | Cluster not in NEW state, can not config cluster subnet. | - |
| 403 | ClusterName.Exist | Cluster name already exists, please use another name. | - |
| 403 | Whitelist.InstanceInCluster | Whitelist.InstanceInCluster | - |
| 404 | Resource.NotFound | Resource not found. | - |
| 405 | ClusterAPI.NotSupported | ClusterAPI not supported in this region. | - |
| 409 | Conflict | Resource is being updated by a previous request. Current request is redundant. | - |
| 409 | Cluster.Conflict | The cluster is being updated by a previous request. Please try again later. | - |
| 500 | ConfigWhitelistFailed.Error | config white list error | - |
| 500 | ActionFailed.Error | internal error, please try again | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | 未知錯誤導致請求處理失敗。 |
訪問錯誤中心查看更多錯誤碼。