Automate Resource Operations with ExecuteOperationSync - CADT - Alibaba Cloud - Cloud Architect Design Tools

Operation description

Executes a product operation synchronously.

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

bpstudio:ExecuteOperationSync

update

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	No	The ID of the Cloud Architect Design Tools (CADT) application.	BE68D71ZY5YYIU9R
ServiceType	string	Yes	The resource type. For example, to perform an operation on a DDS resource, set this parameter to dds. Valid values: dds : dds ecs : ecs	dds
Operation	string	Yes	The type of the operation. Valid values: modifyConnectionString : modifyConnectionString rename : rename	rename
Attributes	object	No	The parameters for the operation. The parameters that you must specify vary based on the value of Operation.
	any	No	When you test this operation, select a parameter type and then enter a value.	Select string type: "CADT"; Select number type: 123
ResourceGroupId	string	No	The ID of the resource group. This ID is used for permission verification.	rg-acfmyjt3c5om3hi
ClientToken	string	No	The idempotence token.	1600765710019

Response elements

Element	Type	Description	Example
	object
Message	string	The error message.	Access key ID cannot be null.
RequestId	string	The request ID.	FDC73B05-5331-57AA-BA93-4C9882792FF5
Data	object	The details of the synchronous operation.	op_xxxxxxxxxxxxxxxxxx_dds_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL
OperationId	string	The operation ID.	op_xxxxxxxx
Status	string	The instance status.	SUCCESS/FAILURE
Message	string	The information about the operation.	"[{"vServerGroupId":"rsp-xxxx","healthCheckHttpVersion":"http1.0","status":"running","gzip":"on","requestId":"89xxxx","description":"abcxxx","bandwidth":-1,"healthCheckTimeout":10,"healthCheckType":"http","aclStatus":"off","unhealthyThreshold":3,"xForwardedFor_SLBID":"off","healthCheckHttpCode":"http_3xx,http_2xx","listenerForward":"off","xForwardedFor":"on","idleTimeout":15,"requestTimeout":60,"listenerPort":80,"healthCheckInterval":2,"healthCheckURI":"/","scheduler":"rr","healthyThreshold":3,"xForwardedFor_proto":"off","xForwardedFor_SLBIP":"off","stickySession":"off","healthCheckMethod":"head","healthCheck":"on","rules":[],"aclIds":[]}]"
Arguments	string	The output of the operation.	{ "tagMap":{ "cadt": [ "12xxxxxxx", "34xxxxxxx" ] } }
Code	string	The result code. A value of 200 indicates that the request was successful. Other values indicate that the request failed.	200

Examples

Success response

JSON format

{
  "Message": "Access key ID cannot be null.",
  "RequestId": "FDC73B05-5331-57AA-BA93-4C9882792FF5",
  "Data": {
    "OperationId": "op_xxxxxxxx",
    "Status": "SUCCESS/FAILURE",
    "Message": "\"[{\"vServerGroupId\":\"rsp-xxxx\",\"healthCheckHttpVersion\":\"http1.0\",\"status\":\"running\",\"gzip\":\"on\",\"requestId\":\"89xxxx\",\"description\":\"abcxxx\",\"bandwidth\":-1,\"healthCheckTimeout\":10,\"healthCheckType\":\"http\",\"aclStatus\":\"off\",\"unhealthyThreshold\":3,\"xForwardedFor_SLBID\":\"off\",\"healthCheckHttpCode\":\"http_3xx,http_2xx\",\"listenerForward\":\"off\",\"xForwardedFor\":\"on\",\"idleTimeout\":15,\"requestTimeout\":60,\"listenerPort\":80,\"healthCheckInterval\":2,\"healthCheckURI\":\"/\",\"scheduler\":\"rr\",\"healthyThreshold\":3,\"xForwardedFor_proto\":\"off\",\"xForwardedFor_SLBIP\":\"off\",\"stickySession\":\"off\",\"healthCheckMethod\":\"head\",\"healthCheck\":\"on\",\"rules\":[],\"aclIds\":[]}]\"",
    "Arguments": "{\n    \"tagMap\":{\n        \"cadt\": [\n          \"12xxxxxxx\",\n          \"34xxxxxxx\"\n        ]\n    }\n}"
  },
  "Code": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.