Disable an activation code by calling DisableActivation - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Disables a specified activation code.

Operation description

If you are concerned that a created activation code may be leaked, you can call this operation to disable the activation code. After the activation code is disabled, it can no longer be used to register new managed instances. However, managed instances that are already registered are not affected.

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:DisableActivation

update

*Activation

acs:ecs:{#regionId}:{#accountId}:activation/{#ActivationId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. The following regions are supported: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), Hong Kong (China), Singapore, Japan (Tokyo), US (Silicon Valley), and US (Virginia). You can call DescribeRegions to query the region IDs and other information.	cn-hangzhou
ActivationId	string	Yes	The activation code ID.	4ECEEE12-56F1-4FBC-9AB1-890F1234****

Response elements

Element	Type	Description	Example
	object
Activation	object	The information about the activation code and its usage.
ActivationId	string	The activation code ID.	4ECEEE12-56F1-4FBC-9AB1-890F1234****
CreationTime	string	The time when the activation code was created. The time is displayed in ISO 8601 format in UTC.	2021-01-20T06:00:00Z
DeregisteredCount	integer	The number of deregistered instances.	1
Description	string	The description of the activation code.	This is description.
Disabled	boolean	Indicates whether the activation code is disabled.	false
InstanceCount	integer	The maximum number of times that the activation code can be used to register managed instances.	1
InstanceName	string	The default instance name prefix.	test-InstanceName
IpAddressRange	string	The IP addresses of hosts that are allowed to use the activation code.	0.0.0.0/0
RegisteredCount	integer	The number of registered instances.	1
TimeToLiveInHours	integer	The validity period of the activation code. Unit: hours.	4
RequestId	string	The request ID.	4ECEEE12-56F1-4FBC-9AB1-890F74942176

Examples

Success response

JSON format

{
  "Activation": {
    "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
    "CreationTime": "2021-01-20T06:00:00Z",
    "DeregisteredCount": 1,
    "Description": "This is description.",
    "Disabled": false,
    "InstanceCount": 1,
    "InstanceName": "test-InstanceName",
    "IpAddressRange": "0.0.0.0/0",
    "RegisteredCount": 1,
    "TimeToLiveInHours": 4
  },
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74942176"
}

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.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	The operation is not supported.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	ActivationId.NotFound	The specified activation id does not exist.	The specified activation code does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.