Automate Cross-Region App Sync via SynchronizeApp API - E-HPC Instant - Alibaba Cloud - Elastic High Performance Computing

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:SynchronizeApp

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	ci-vm-rYfypJKwlN9Y
TargetRegionIds	array	No	The list of target region IDs to synchronize the application to. If the value includes 'all', the application is synchronized to all unsynchronized regions.
	string	No	The region ID.	cn-shanghai

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	896D338C-E4F4-41EC-A154-D605E5DE****

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ImageAlreadyExists	The image id already exists.	Mirror already exists
403	InvalidParams	Invalid parameters: %s.	Request parameter error:%s.
404	ImageNotFound	The specified image does not exist.	The specified image does not exist. Please verify the parameter.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.
406	DbError	A database error occurred.	A database error occurred.
406	ServiceAPIError	Failed to call the operation. Cause:%s.	An error occurred while calling the API. %s.
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.