ExecuteOperationASync - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

Asynchronous execution of product operation functions.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
bpstudio:ExecuteOperationASync	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	No	The ID of the Cloud Architect Design Tools (CADT) application.	BG**********UQ
ServiceType	string	Yes	The type of the service. If you want to perform operations on an Elastic Compute Service (ECS) instance, set ServiceType to ecs.	ACK
Operation	string	Yes	This operation type is the operation type of modifying the product, some operation types are generic, and some are used alone. The following is an example of ECS deployment: The name of the ECS: rename Specification of ecs: modifyInstanceType Startup of ecs: modifyInstanceType Stop of ecs: modifyInstanceType Restart of ecs: modifyInstanceType Ecs Tag: addTags Deletion of ecs: ecsDelete Paid type for ecs: modifyPayType	queryTopo
Attributes	object	No	The parameters related to the action. Specify the parameters based on the value of Operation. The parameters are passed in the map format. The following examples show how to specify the parameters if you want to change the specifications of an Elastic Compute Service (ECS) instance: The following common parameters are required: change_type, regionId, instanceId, appId Example values for changing the instance type of the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_instance_type","instance_type":"ecs.hfr7.2xlarge","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" } Example values for stopping the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_status","status":"Stopped","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" } Example values for starting the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_status","status":"Running","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" } Example values for restarting the ECS instance: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{"change_type":"modify_status","status":"Restart","instanceId":"i-xxxxxxxxx","regionId":"cn-beijing","appId":"xxxxxxxxxxxxx"}" } Example of enumerating more than one set of parameters: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\"change_type\":\"modify_instance_type\",\"instance_type\":\"ecs.hfr7.2xlarge\",\"instanceId\":\"i-xxxxxxxxx\",\"regionId\":\"cn-beijing\",\"appId\":\"xxxxxxxxxxxxx\"}" } : { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\"change_type\":\"modify_instance_type\",\"instance_type\":\"ecs.hfr7.2xlarge\",\"instanceId\":\"i-xxxxxxxxx\",\"regionId\":\"cn-beijing\",\"appId\":\"xxxxxxxxxxxxx\"}" } Enumeration Value: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\"change_type\":\"modify_instance_type\",\"instance_type\":\"ecs.hfr7.2xlarge\",\"instanceId\":\"i-xxxxxxxxx\",\"regionId\":\"cn-beijing\",\"appId\":\"xxxxxxxxxxxxx\"}" }: { "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\"change_type\":\"modify_instance_type\",\"instance_type\":\"ecs.hfr7.2xlarge\",\"instanceId\":\"i-xxxxxxxxx\",\"regionId\":\"cn-beijing\",\"appId\":\"xxxxxxxxxxxxx\"}" }.
	string	No	Select a parameter type before you specify the parameter during debugging.	cn-hangzhou
ResourceGroupId	string	No	Resource group ID, which is used to verify the permissions of the resource group	ceshi
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	1600765710019

Response parameters

Parameter	Type	Description	Example
	object
Message	string	Error message	" "
RequestId	string	Request ID	SD-WEF-DSW-32ED-323DDSD-2332D
Data	string	The operation ID. You can call the GetExecuteOperationResult operation to asynchronously query the result of an operation. The ID expires after one hour.	op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL
Code	integer	Result code, 200 for success; Other representatives fail.	200

Examples

Sample success responses

JSONformat

{
  "Message": " ",
  "RequestId": "SD-WEF-DSW-32ED-323DDSD-2332D",
  "Data": "op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL",
  "Code": 200
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-08-01	The request parameters of the API has changed	View Change Details
2023-05-22	The response structure of the API has changed	View Change Details
2022-08-16	Add Operation	View Change Details