DisableActivation-阿里云帮助中心

To prevent an activation code from being leaked, you can call the DisableActivation operation to disable the activation code. Disabled activation codes cannot be used to register new managed instances. However, managed instances that are already registered are not affected.

Operation description

Usage notes

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. 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
ActivationId	string	Yes	The request ID.	4ECEEE12-56F1-4FBC-9AB1-890F1234****

Response elements

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

Examples

Success response

JSON format

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

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	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.