All Products
Search
Document Center

Elastic High Performance Computing:SyncUsers

Last Updated:Jul 31, 2025

Synchronizes local cluster users to a hybrid cloud cluster in hybrid-cloud proxy mode.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:SyncUsers
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

You can call the ListRegions operation to query the list of regions where E-HPC is supported.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

You can call the ListClusters operation to query the list of E-HPC clusters.

ehpc-hz-gh5WKb****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7****

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe parameters are invalid.Invalid parameter. %s
403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
403ExecFailFailed to execute the command: %s.Failed to execute the command: %s.
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.The manager nodes do not exist or their status is abnormal.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
406AgentError.Account.UserSynFailuresynchronize users failed: %s-
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-12-23Add OperationView Change Details