CreateActivation创建激活码以注册非阿里云服务器为托管实例-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

该接口用于创建一个激活码，该激活码用于将非阿里云服务器注册为阿里云托管实例。

接口说明

通过激活码将非阿里云服务器注册为阿里云托管实例后，您可以在托管实例中使用阿里云提供的多种在线服务（例如云助手、系统运维管理和云效等服务）。

非阿里云服务器的操作系统需要符合以下版本，且服务器可以访问公网，才可以注册为阿里云托管实例。

Alibaba Cloud Linux 2/3 及更高版本
CentOS 6/7/8 及更高版本
Debian 8/9/10 及更高版本
Ubuntu 12/14/16/18 及更高版本
CoreOS
OpenSUSE
RedHat 5/6/7 及更高版本
SUSE Linux Enterprise Server 11/12/15 及更高版本
Window Server 2012/2016/2019 及更高版本

在一个阿里云地域下，您最多可以拥有 10 条托管实例激活码，一个激活码可激活实例上限为 10 个，单个激活码有效期上限为 4 小时。

说明

您可以在 ECS 云助手页面的托管实例页签下，单击注册新实例，获取激活码使用数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:CreateActivation

create

*Activation

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。目前支持的地域：华北 1（青岛）、华北 2（北京）、华北 3（张家口）、华北 5（呼和浩特）、华北 6（乌兰察布）、华东 1（杭州）、华东 2（上海）、华南 1（深圳）、华南 2（河源）、华南 3（广州）、西南 1（成都）、中国香港、新加坡、日本（东京）、美国（硅谷）、美国（弗吉尼亚）。您可以调用 DescribeRegions 查看地域对应的 ID 等信息。	cn-hangzhou
InstanceName	string	否	默认的实例名称前缀。支持 2~50 个字符，且必须以字母开头，不能以特殊字符及数字开头，只可包含特殊字符中的半角句号（.）、下划线（_）、短划线（-）和半角冒号（:），不可以使用`http://`或`https://`开头。使用该接口创建的激活码注册的实例，将使用该名称作为前缀，生成有序的实例名。您也可以在注册托管实例时，指定新的实例名称以覆盖此默认值。注册托管实例时，如果指定了 InstanceName 的值，则会生成名称`<InstanceName>-001`，其中编号`001`数字的位数取决于`InstanceCount`数值的位数。如果未指定 InstanceName 的值，则会使用主机的主机名（Hostname）作为实例的名称。	test-InstanceName
Description	string	否	激活码对应的描述。支持 1~100 个字符。	This is description.
InstanceCount	integer	否	激活码用于注册托管实例的使用次数上限。取值范围为 1~1000。默认值为 10。	10
TimeToLiveInHours	integer	否	激活码的有效使用时间，过期后将不能用于注册新的实例。单位：小时。可选值：1~4。默认值为 4 小时。	4
IpAddressRange	string	否	允许使用该激活码的主机 IP。取值为对应的 IPv4 地址、IPv6 地址或 CIDR 地址段。	0.0.0.0/0
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-426655440000
ResourceGroupId	string	否	激活码所属的资源组 ID。	rg-123******
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	托管实例激活码的标签键。N 的取值范围为 1~20。一旦传入该值，则不允许为空字符串。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个。使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，您需要使用 ListTagResources 接口进行查询。最多支持 64 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	TestKey
Value	string	否	托管实例激活码的标签值。N 的取值范围为 1~20。该值可以为空字符串。最多支持 128 个字符，不能包含`http://`或`https://`。	TestValue

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	4ECEEE12-56F1-4FBC-9AB1-890F1234****
ActivationCode	string	激活码的代码。该代码仅在调用接口时返回一次，后续无法被查询。因此，请您务必妥善保存返回值。	a-hz0ch3SwhOlE1234+Xo32lAZC****
ActivationId	string	激活码 ID。	4ECEEE12-56F1-4FBC-9AB1-890F1234****

示例

正常返回示例

JSON格式

{
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
  "ActivationCode": "a-hz0ch3SwhOlE1234+Xo32lAZC****",
  "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400	InstanceName.ExceedLimit	Default instance name prefix length exceeds.	实例名称前缀的长度超过上限。
400	InstanceName.InvalidPattern	Default instance name prefix pattern invalid.	实例名称前缀不合法。
400	ActivationDesc.ExceedLimit	Activation description length exceeds.	激活码对应的描述长度超过上限。
400	ActivationLimitation.Invalid	The specified parameter InstanceCount exceeds the limit of %s.	指定的参数InstanceCount超过了%s的限制。
400	AddressRange.InvalidPattern	Address range should be ipv4 address or cidr.	允许使用该激活码的主机IP必须为对应的IPv4地址、IPv6地址或CIDR地址段。
400	ActivationCount.ExceedLimit	The count of activation in current region exceeds the limit of %s.	当前地域下的激活码数量超过了%s的限制。
400	ActivationTTL.ExceedLimit	The specified parameter TimeToLiveInHours exceeds the limit of %s.	指定的参数TimeToLiveInHours超过了%s的限制。
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定的标签键参数有误。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定的标签值参数有误。
400	NumberExceed.Tags	The Tags parameter number is exceed.	标签个数超过最大限制。
400	MissingParameter.TagKey	You must specify Tag.N.Key.	请指定标签键。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	标签中存在重复的键，请保持键的唯一性。
400	InvalidClientToken.Malformed	The specified parameter clientToken is not valid.	指定的幂等参数不合法。
500	InternalError.Dispatch	An error occurred when dispatch the request.	发送请求时发生错误，请稍后重试。
403	Operation.Forbidden	The operation is not permitted.	该操作是不被允许的。
403	InvalidStatus.ResourceGroup	You cannot perform an operation on a resource group that is being created or deleted.	资源组正在创建或删除时不允许操作。
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.	您的阿里云账号尚未通过实名认证，请先实名认证后再操作。
403	ManagedInstanceCountExceedLimit	The count of managed instance in current region exceeds the limit of %s.	当前地域下的托管实例数量超过了%s的限制。
403	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.	指定的客户令牌已经被使用。
403	IdempotentProcessing	The previous idempotent request(s) is still processing.	先前的幂等请求仍在处理中，请稍后重试。
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	地域信息错误
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	资源组并不在记录中。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。