InstallAgent - Enterprise Distributed Application Service

Operation description

If you call this operation to import an ECS instance into EDAS, the operating system of the ECS instance is not reinstalled. We recommend that you call this operation to import ECS instances into EDAS.

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

edas:ManageCluster

none

*Cluster

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}

None

Request syntax

POST /pop/v5/ecss/install_agent HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	b3e3f77b-462e-**-**-bec8727a4dc8
InstanceIds	string	Yes	The ID of the ECS instance. Separate multiple IDs with commas (,). Example: instanceId1,instanceId2.	2ze7s2v0b789k60pk1af
DoAsync	boolean	No	This parameter is discontinued.	true

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The message that is returned.	success
RequestId	string	The ID of the request.	b197-40ab-9155-7ca7
ExecutionResultList	object
ExecutionResult	array<object>	The execution result.
	object
Status	string	The state of the installation command.	OK
FinishedTime	string	The time when the installation was complete.	20**-11-10T07:02:17Z
InstanceId	string	The ID of the instance.	i-2ze7s2v0b789k*******
InvokeRecordStatus	string	The state of the installation.	Finished
Success	boolean	Indicates whether the installation was successful.	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-7ca7",
  "ExecutionResultList": {
    "ExecutionResult": [
      {
        "Status": "OK",
        "FinishedTime": "20**-11-10T07:02:17Z",
        "InstanceId": "i-2ze7s2v0b789k*******",
        "InvokeRecordStatus": "Finished",
        "Success": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.