All Products
Search
Document Center

Elastic Compute Service:DisableActivation

Last Updated:Dec 23, 2024

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

The region ID. The following regions are supported: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), and China (Hong Kong).

You can call the DescribeRegions operation to query the most recent region list.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DisableActivationupdate
*Activation
acs:ecs:{#regionId}:{#accountId}:activation/{#ActivationId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The activation code ID.

cn-hangzhou
ActivationIdstringYes

The request ID.

4ECEEE12-56F1-4FBC-9AB1-890F1234****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Details about the activation code and its usage information.

4ECEEE12-56F1-4FBC-9AB1-890F74942176
Activationobject

The time when the activation code was created.

CreationTimestring

The number of instances that were deregistered.

2021-01-20T06:00:00Z
DeregisteredCountinteger

The maximum number of times that the activation code can be used to register managed instances.

1
InstanceCountinteger

The description of the activation code.

1
Descriptionstring

The number of registered instances.

This is description.
RegisteredCountinteger

The default prefix of the instance name.

1
InstanceNamestring

Indicates whether the activation code is disabled.

test-InstanceName
Disabledboolean

The IP addresses of the hosts that can use the activation code.

false
IpAddressRangestring

The validity period of the activation code. Unit: hours.

0.0.0.0/0
TimeToLiveInHourslong

The activation code ID.

4

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400RegionId.ApiNotSupportedThe 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.
403Operation.ForbiddenThe operation is not permitted.The operation is not supported.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404ActivationId.NotFoundThe specified activation id does not exist.The specified activation code does not exist.
500InternalError.DispatchAn error occurred when you dispatched the request.An error occurred while the request is being sent. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-05API Description Update. The Error code has changedView Change Details
2022-02-25The Error code has changedView Change Details