Use DeregisterManagedInstance to deregister a managed instance - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

You can invoke DeregisterManagedInstance to log off a managed instance. After logging off, you can no longer use Cloud Assistant to send commands or files to the instance.

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

ecs:DeregisterManagedInstance

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Supported regions: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), China (Hong Kong), Singapore, Japan (Tokyo), US (Silicon Valley), and US (Virginia). You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RegionId	string	Yes	The region ID. Supported regions: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), China (Hong Kong), Singapore, Japan (Tokyo), US (Silicon Valley), and US (Virginia). You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	Yes	The managed instance ID.	mi-hz01axdfas****
ClientToken	string	No	Ensures the idempotence of the request. Generate a unique value for this parameter from your client to guarantee that the value is unique across different requests. ClientToken supports only ASCII characters and must not exceed 64 characters. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4ECEEE12-56F1-4FBC-9AB1-890F74942176
Instance	object	Details of the managed instances.
LastInvokedTime	string	The time when the Cloud Assistant task was last executed.	2021-01-20T09:00:40Z
InternetIp	string	The public IP address of the managed instance.	47.8..
Hostname	string	The hostname of the managed instance.	test-Hostname
InstanceId	string	The managed instance ID.	mi-hz01axdfas****
ActivationId	string	The activation code ID.	4ECEEE12-56F1-4FBC-9AB1-890F7494****
IntranetIp	string	The internal IP address of the managed instance.	10.0..
AgentVersion	string	The version number of Cloud Assistant Agent.	2.2.0.102
RegistrationTime	string	The time when the managed instance was registered.	2021-01-20T08:57:56Z
InstanceName	string	The name of the managed instance.	test-InstanceName-001
OsType	string	The operating system type of the managed instance.	linux
OsVersion	string	The version information about the operating system.	Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64
InvocationCount	integer	The number of times that Cloud Assistant tasks were executed on the managed instance.	2
MachineId	string	The machine code of the managed instance.	e03231b37ab14e53b5795ad625fc****
ResourceGroupId	string	The ID of the resource group to which the managed instance belongs.	rg-123******

Examples

Success response

JSON format

{
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74942176",
  "Instance": {
    "LastInvokedTime": "2021-01-20T09:00:40Z",
    "InternetIp": "47.8.**.**",
    "Hostname": "test-Hostname",
    "InstanceId": "mi-hz01axdfas****",
    "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F7494****",
    "IntranetIp": "10.0.**.**",
    "AgentVersion": "2.2.0.102",
    "RegistrationTime": "2021-01-20T08:57:56Z",
    "InstanceName": "test-InstanceName-001",
    "OsType": "linux",
    "OsVersion": "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
    "InvocationCount": 2,
    "MachineId": "e03231b37ab14e53b5795ad625fc****",
    "ResourceGroupId": "rg-123******"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	The API operation cannot be called in the specified region. Check whether the specified RegionId parameter is valid.
400	InvalidClientToken.Malformed	The specified parameter clientToken is not valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.
403	Operation.Forbidden	The operation is not permitted.	The operation is not supported.
403	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.
403	IdempotentProcessing	The previous idempotent request(s) is still processing.	A previous idempotent request is being processed. Try again later.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidInstance.NotFound	The specified instance id does not exist.	The specified instance ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.